Package com.hp.lft.sdk.sap.gui

Class ElementDescription

java.lang.Object
com.hp.lft.sdk.internal.PropertiesDescriptionBase
com.hp.lft.sdk.PropertiesDescription
com.hp.lft.sdk.DescriptionBase
com.hp.lft.sdk.sap.gui.ElementDescription
All Implemented Interfaces:
CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, Cloneable
Direct Known Subclasses:
ButtonDescription, CalendarDescription, CheckBoxDescription, ComboBoxDescription, EditFieldDescription, EditorDescription, LabelDescription, MenubarDescription, OKCodeDescription, RadioButtonDescription, StatusBarDescription, TabControlDescription, TableBaseDescription, ToolBarDescription, TreeViewDescription, WindowDescription
public class ElementDescription extends DescriptionBase
The description of a SAP GUI for Windows element.

  • Constructor Details

    • ElementDescription

      public ElementDescription()
      Initializes a new instance of the ElementDescription class.

    • ElementDescription

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

  • Method Details

    • setType

      public void setType(ComponentType type)
      Sets the GUI component type.
      Parameters:
      type - the GUI component type.

    • getType

      public ComponentType getType()
      Returns the GUI component type.
      Returns:
      the GUI component type.

    • setId

      public void setId(StringProperty id)
      Sets the element's unique identifier.
      Parameters:
      id - a StringProperty or RegExpProperty.

    • setId

      public void setId(String id)
      Sets the element's unique identifier.
      Parameters:
      id - the element's unique identifier in text format.

    • getId

      public StringProperty getId()
      Returns the element's unique identifier.
      Returns:
      the unique identifier.

    • setName

      public void setName(StringProperty name)
      Sets the name of the element.
      Parameters:
      name - a StringProperty or RegExpProperty.

    • setName

      public void setName(String name)
      Sets the name of the element.
      Parameters:
      name - the name of the element.

    • getName

      public StringProperty getName()
      Returns the name of the element.
      Returns:
      the name of the element.

    • setLocation

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

    • setLocation

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

    • setLocation

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

    • getLocation

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

    • setAbsoluteLocation

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

    • setAbsoluteLocation

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

    • setAbsoluteLocation

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

    • getAbsoluteLocation

      public LocationProperty getAbsoluteLocation()
      Returns the element's coordinates relative to the screen in pixels. 0,0 is the top-left corner of the primary monitor.
      Returns:
      the element's absolute coordinates.

    • setSize

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

    • setSize

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

    • setSize

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

    • getSize

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