Open topic with navigation

com.hp.lft.sdk.sap.gui

## Class OKCodeDescription

- 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
        - - com.hp.lft.sdk.sap.gui.OKCodeDescription

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, java.lang.Cloneable

      public class OKCodeDescription
      extends ElementDescription

  Description of a SAP GUI for Windows OK Code box.

- - ### Nested Class Summary

    Modifier and Type | Class and Description
    --- | ---
    `static class` | `OKCodeDescription.Builder` This class can be used to construct an instance of the OKCodeDescription class using the builder pattern.
    `protected static class` | `OKCodeDescription.Init<T extends OKCodeDescription.Init<T>>` Helper class for OKCodeDescription.Builder.

  - ### Field Summary

    - ### Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `properties`

  - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `` | `OKCodeDescription()` Initializes a new instance of the OKCodeDescription class.
    `protected` | `OKCodeDescription(OKCodeDescription.Init<?> init)` Initializes a new instance of the OKCodeDescription class using the Builder pattern.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getValue()` Returns the command code entered in the field.
    `void` | `setValue(java.lang.String value)` Sets the command code entered in the field.
    `void` | `setValue(StringProperty value)` Sets the command code entered in the field.

    - ### Methods inherited from class com.hp.lft.sdk.sap.gui.ElementDescription

      `getAbsoluteLocation, getId, getLocation, getName, getSize, getType, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setId, setId, setLocation, setLocation, setLocation, setName, setName, setSize, setSize, setSize, setType`

    - ### Methods inherited from class com.hp.lft.sdk.DescriptionBase

      `cloneTo, getIndex, getIndexType, getVRI, setIndex, setIndexType, setVRI, setVRI`

    - ### Methods inherited from class com.hp.lft.sdk.PropertiesDescription

      `clone`

    - ### Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `getValueAs, getValueAsStringProperty, insertValue`

    - ### Methods inherited from class java.lang.Object

      `equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface com.hp.lft.sdk.CloneableObject

      `clone`

- - ### Constructor Detail

    - #### OKCodeDescription

          public OKCodeDescription()

      Initializes a new instance of the OKCodeDescription class.

    - #### OKCodeDescription

          protected OKCodeDescription(OKCodeDescription.Init<?> init)

      Initializes a new instance of the OKCodeDescription class using the Builder pattern.
      Parameters:
        `init` - the Builder pattern.

  - ### Method Detail

    - #### setValue

          public void setValue(StringProperty value)

      Sets the command code entered in the field.
      Parameters:
        `value` - a `StringProperty` or `RegExpProperty`.

    - #### setValue

          public void setValue(java.lang.String value)

      Sets the command code entered in the field.
      Parameters:
        `value` - the command code.

    - #### getValue

          public StringProperty getValue()

      Returns the command code entered in the field.
      Returns:
        the command code.