Package com.hp.lft.sdk.java

Class UiObjectBaseDescription

java.lang.Object
com.hp.lft.sdk.internal.PropertiesDescriptionBase
com.hp.lft.sdk.PropertiesDescription
com.hp.lft.sdk.DescriptionBase
com.hp.lft.sdk.java.UiObjectBaseDescription
All Implemented Interfaces:
CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, Cloneable
Direct Known Subclasses:
AppletDescription, ButtonDescription, CalendarDescription, CheckBoxDescription, EditorDescription, ExpandBarDescription, LabelDescription, LinkDescription, ListDescription, MenuDescription, RadioButtonDescription, SliderDescription, SpinBoxDescription, TabControlDescription, TableDescription, ToolBarDescription, TreeViewDescription, TreeViewTableDescription, UiObjectDescription, WindowDescription
public class UiObjectBaseDescription extends DescriptionBase
The base description of all Java test objects.

  • Constructor Details

    • UiObjectBaseDescription

      public UiObjectBaseDescription()
      Constructs a new instance of UiObjectDescriptionBase.

    • UiObjectBaseDescription

      protected UiObjectBaseDescription(UiObjectBaseDescription.Init<?> init)
      Initializes a new instance of the UiObjectBaseDescription class using the Builder pattern.
      Parameters:
      init - the Builder pattern.

  • Method Details

    • setAttachedText

      public void setAttachedText(String attachedText)
      Sets the static text that is attached to an object.
      Parameters:
      attachedText - static text that is attached to an object.

    • setAttachedText

      public void setAttachedText(StringProperty attachedText)
      Sets static text that is attached to an object.
      Parameters:
      attachedText - a StringProperty or RegExpProperty.

    • getAttachedText

      public StringProperty getAttachedText()
      Returns static text that is attached to an object.
      Returns:
      static text that is attached to an object.

    • setForegroundColor

      public void setForegroundColor(String color)
      Sets the object's foreground color.
      Parameters:
      color - object's foreground color.

    • setForegroundColor

      public void setForegroundColor(StringProperty color)
      Sets the object's foreground color.
      Parameters:
      color - a StringProperty or RegExpProperty.

    • getForegroundColor

      public StringProperty getForegroundColor()
      Returns the object's foreground color.
      Returns:
      the object's foreground color.

    • setBackgroundColor

      public void setBackgroundColor(String color)
      Sets the object's background color.
      Parameters:
      color - object's background color.

    • setBackgroundColor

      public void setBackgroundColor(StringProperty color)
      Sets the object's background color.
      Parameters:
      color - a StringProperty or RegExpProperty.

    • getBackgroundColor

      public StringProperty getBackgroundColor()
      Returns the object's background color.
      Returns:
      the object's background color.

    • setObjectName

      public void setObjectName(String name)
      Sets the test object description's ObjectName property.
      Parameters:
      name - the ObjectName property.

    • setObjectName

      public void setObjectName(StringProperty name)
      Sets the test object description's ObjectName property.
      Parameters:
      name - a StringProperty or RegExpProperty.

    • getObjectName

      public StringProperty getObjectName()
      Returns the test object's ObjectName. Given the statement "Editbox newEditBox = new Editbox(0,0)", the default test object name is "newEditBox". The default test object name can be overridden using setObjectName(java.lang.String).
      Returns:
      the instance variable name.

    • setEnabled

      public void setEnabled(Boolean isEnabled)
      Sets whether the object is enabled.
      Parameters:
      isEnabled - true if enabled.

    • isEnabled

      public Boolean isEnabled()
      Indicates whether the object is enabled.
      Returns:
      true if enabled.

    • setWrapped

      public void setWrapped(Boolean isWrapped)
      Sets wether the object is wrapped.
      Parameters:
      isWrapped - true if wrapped.

    • isWrapped

      public Boolean isWrapped()
      Indicates whether the object is wrapped.
      Returns:
      true if wrapped.

    • setFocused

      public void setFocused(Boolean isFocused)
      Sets whether the object has focus.
      Parameters:
      isFocused - true if has focus.

    • isFocused

      public Boolean isFocused()
      Indicates whether the object has focus.
      Returns:
      true if has focus.

    • setVisible

      public void setVisible(Boolean isVisible)
      Sets the object is visible.
      Parameters:
      isVisible - true to make visible.

    • isVisible

      public Boolean isVisible()
      Indicates whether the object is visible.
      Returns:
      true, if visible.

    • setLabel

      public void setLabel(String label)
      Sets the test object's label.
      Parameters:
      label - the test object's label.

    • setLabel

      public void setLabel(StringProperty label)
      Sets the test object's label.
      Parameters:
      label - a StringProperty or RegExpProperty.

    • getLabel

      public StringProperty getLabel()
      Returns the test object's label.
      Returns:
      the test object's label.

    • setPath

      public void setPath(String path)
      Sets the object's hierarchy (object ancestors).
      Parameters:
      path - the object's hierarchy (object ancestors).

    • setPath

      public void setPath(StringProperty path)
      Sets the object's hierarchy (object ancestors).
      Parameters:
      path - a StringProperty or RegExpProperty.

    • getPath

      public StringProperty getPath()
      Returns the object's hierarchy (object ancestors).
      Returns:
      the object's hierarchy (object ancestors).

    • setTagName

      public void setTagName(String tagName)
      Sets the test object's name.
      Parameters:
      tagName - the test object's name.

    • setTagName

      public void setTagName(StringProperty tagName)
      Sets the test object's name.
      Parameters:
      tagName - a StringProperty or RegExpProperty.

    • getTagName

      public StringProperty getTagName()
      Returns the test object's name.
      Returns:
      the test object's name.

    • setNativeClass

      public void setNativeClass(String nativeClass)
      Sets the object's Java class name.
      Parameters:
      nativeClass - the object's Java class name.

    • setNativeClass

      public void setNativeClass(StringProperty nativeClass)
      Sets the object's Java class name.
      Parameters:
      nativeClass - a StringProperty or RegExpProperty.

    • getNativeClass

      public StringProperty getNativeClass()
      Returns the object's Java class name.
      Returns:
      the object's Java class name.

    • setLocation

      public void setLocation(LocationProperty location)
      Sets the object's coordinates in pixels relative to the parent window.
      Parameters:
      location - the coordinates relative to the parent window.

    • setLocation

      public void setLocation(Integer x, Integer y)
      Sets the object's coordinates in pixels relative to the parent window.
      Parameters:
      x - in pixels.
      y - in pixels.

    • setLocation

      public void setLocation(Point location)
      Sets the object's coordinates in pixels relative to the parent window.
      Parameters:
      location - the coordinates relative to the parent window.

    • getLocation

      public LocationProperty getLocation()
      Returns the object's coordinates in pixels relative to the parent window.
      Returns:
      the coordinates relative to the parent window.

    • setAbsoluteLocation

      public void setAbsoluteLocation(LocationProperty absLocation)
      Sets the object's coordinates in pixels relative to the screen. 0,0 is the top-left corner of the primary monitor.

      In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, this coordinate is relative to the virtual coordinate system. Otherwise, this coordinate is relative to the coordinate system associated with the Component's GraphicsConfiguration.

      Parameters:
      absLocation - the coordinates relative to the screen.

    • setAbsoluteLocation

      public void setAbsoluteLocation(Integer absX, Integer absY)
      Sets the object's coordinates in pixels relative to the screen. 0,0 is the top-left corner of the primary monitor.

      In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, this coordinate is relative to the virtual coordinate system. Otherwise, this coordinate is relative to the coordinate system associated with the Component's GraphicsConfiguration.

      Parameters:
      absX - in pixels.
      absY - in pixels.

    • setAbsoluteLocation

      public void setAbsoluteLocation(Point absLocation)
      Sets the object's coordinates in pixels relative to the screen. 0,0 is the top-left corner of the primary monitor.
      Parameters:
      absLocation - the coordinates relative to the screen.

    • getAbsoluteLocation

      public LocationProperty getAbsoluteLocation()
      Returns the object's coordinates in pixels relative to the screen.

      In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, this coordinate is relative to the virtual coordinate system. Otherwise, this coordinate is relative to the coordinate system associated with the Component's GraphicsConfiguration.

      Returns:
      the coordinates relative to the screen.

    • setSize

      public void setSize(SizeProperty size)
      Sets the test object's size in pixels.
      Parameters:
      size - the size.

    • setSize

      public void setSize(Dimension size)
      Sets the test object's size in pixels.
      Parameters:
      size - the size.

    • setSize

      public void setSize(Integer width, Integer height)
      Sets the test object's size in pixels.
      Parameters:
      width - in pixels.
      height - in pixels.

    • getSize

      public SizeProperty getSize()
      Returns the test object's size in pixels.
      Returns:
      the size.