Package oracle.forms.jdapi

Class Item

java.lang.Object
oracle.forms.jdapi.Item
All Implemented Interfaces:
JdapiObject
public class Item extends Object
Object to represent a Forms Item object. This is an encapsulation of the Forms C API d2fitm.

In some cases, using methods on this class may result in a JdapiIllegalStateException being thrown. When this happens, you are using an object that refers to a Forms object that has been deleted - your reference is no longer valid. You can check if an instance of this class is valid by using the isValidFormsObject() method. If you code correctly, this should not happen. It will tend to happen if you keep references (for extended periods) to Forms objects rather than look them up dynamically. Of course you will only have this problem if you destroy Forms objects.

See Also:
  • BaseAPI

  • Field Details

    • m_pd2fob

      protected transient long m_pd2fob
      This is the d2fob pointer in the C ifjapi60 for the object that is derived from this class.

    • m_clientInfo

      protected transient Object m_clientInfo
      Client info object held against this Forms object.

  • Constructor Details

    • Item

      public Item(Block parent, String name)
      Constructor used to create Item objects in the context of a Block parent object.
      Parameters:
      parent - Parent object
      name - Name of the new object

    • Item

      public Item(Block parent, String name, Item base)
      Constructor used to create Item objects in the context of a Block parent object. The newly created object is derived from the 'base' object.
      Parameters:
      parent - Parent object
      name - Name of the new object
      base - Item object to derive from

    • Item

      public Item(Block parent, String name, PropertyClass base)
      Constructor used to create Item objects in the context of a Block parent object. The newly created object is derived from the 'base' PropertyClass.
      Parameters:
      parent - Parent object
      name - Name of the new object
      base - PropertyClass object to derive from

    • Item

      public Item(ObjectLibrary olb, ObjectLibraryTab tab, String name)
      Constructor used to create Item objects in the context of an ObjectLibraryTab parent object.
      Parameters:
      olb - The ObjectLibrary module to create this object in
      tab - The tab in the passed ObjectLibrary to attach the new object to
      name - Name of the new object

    • Item

      public Item(ObjectLibrary olb, ObjectLibraryTab tab, String name, Item base)
      Constructor used to create Item objects in the context of an ObjectLibraryTab parent object. The newly created object is derived from the 'base' object.
      Parameters:
      olb - The ObjectLibrary module to create this object in
      tab - The tab in the passed ObjectLibrary to attach the new object to
      name - Name of the new object
      base - Item object to derive from

    • Item

      public Item(ObjectLibrary olb, ObjectLibraryTab tab, String name, PropertyClass base)
      Constructor used to create Item objects in the context of an ObjectLibraryTab parent object. The newly created object is derived from the 'base' PropertyClass.
      Parameters:
      olb - The ObjectLibrary module to create this object in
      tab - The tab in the passed ObjectLibrary to attach the new object to
      name - Name of the new object
      base - PropertyClass object to derive from

    • Item

      protected Item(long pd2fitm)
      Protected constructor, used internally to create Item objects. This doesn't actually create a new Item, it just creates a Java instance for an already existing Forms object.

      Do NOT use this constructor, even within the Jdapi package. If you have a pointer and need to instantiate it's Java representation, get the object via the context cache, e.g. 

       myBaseObject = Jdapi.getObject(myPointer);
      Parameters:
      pd2fitm - C pointer to Forms object

  • Method Details

    • getTypeId

      public int getTypeId()
      Gets the HtmlForms object type ID.
      Specified by:
      getTypeId in interface JdapiObject
      Returns:
      X_OTID ID for this object type
      See Also:

    • clone

      public Item clone(Block parent, String newName)
      Creates a copy of the object as a child of 'parent'
      Parameters:
      parent - Parent object
      newName - Name of object that's being created
      Returns:
      Replicant object

    • clone

      public Item clone(ObjectLibraryTab parent, String newName)
      Creates a copy of the object as a child of 'parent'
      Parameters:
      parent - Parent object
      newName - Name of object that's being created
      Returns:
      Replicant object

    • find

      public static Item find(Block parent, String name)
      Find an instance of Item that is a child of a Block.
      Parameters:
      parent - Parent object of object you wish to find
      name - Name of object you wish to find
      Returns:
      Object instance you are looking for, or null if none was found

    • find

      public static Item find(ObjectLibraryTab parent, String name)
      Find an instance of Item that is a child of a ObjectLibraryTab.
      Parameters:
      parent - Parent object of object you wish to find
      name - Name of object you wish to find
      Returns:
      Object instance you are looking for, or null if none was found

    • insertElement

      public void insertElement(int index, String label, String value)
      Insert a row into the list elements of a list item. A list item is a poplist, textlist, or combo-box.
      Parameters:
      index - Index to insert row at
      label - List element label
      value - List element value

    • deleteElement

      public void deleteElement(int index)
      Deletes a row from the list elements of a list item. A list item is a poplist, textlist, or combo-box.
      Parameters:
      index - Index of row to delete

    • getElementLabel

      public String getElementLabel(int index)
      Retrieves the label of a list element row of a list item. A list item is a poplist, textlist, or combo-box.
      Parameters:
      index - Index of row which contains the label
      Returns:
      index The label in list element row

    • getElementValue

      public String getElementValue(int index)
      Retrieves the value of a list element row of a list item. A list item is a poplist, textlist, or combo-box.
      Parameters:
      index - Index of row which contains the value
      Returns:
      index The value in list element row

    • getAccessKey

      public String getAccessKey()
      Get text property AccessKey (ACCESS_KEY_PTID).
      Returns:
      Value of property

    • setAccessKey

      public void setAccessKey(String value)
      Sets text property AccessKey (ACCESS_KEY_PTID).
      Parameters:
      value - Value to set property to

    • getBackColor

      public String getBackColor()
      Get text property BackColor (BACK_COLOR_PTID).
      Returns:
      Value of property

    • setBackColor

      public void setBackColor(String value)
      Sets text property BackColor (BACK_COLOR_PTID).
      Parameters:
      value - Value to set property to

    • getCheckedValue

      public String getCheckedValue()
      Get text property CheckedValue (CHECKED_VALUE_PTID).
      Returns:
      Value of property

    • setCheckedValue

      public void setCheckedValue(String value)
      Sets text property CheckedValue (CHECKED_VALUE_PTID).
      Parameters:
      value - Value to set property to

    • getCanvasName

      public String getCanvasName()
      Get text property CanvasName (CANVAS_NAME_PTID).
      Returns:
      Value of property

    • setCanvasName

      public void setCanvasName(String value)
      Sets text property CanvasName (CANVAS_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getColumnName

      public String getColumnName()
      Get text property ColumnName (COLUMN_NAME_PTID).
      Returns:
      Value of property

    • setColumnName

      public void setColumnName(String value)
      Sets text property ColumnName (COLUMN_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getComment

      public String getComment()
      Get text property Comment (COMMENT_PTID).
      Returns:
      Value of property

    • setComment

      public void setComment(String value)
      Sets text property Comment (COMMENT_PTID).
      Parameters:
      value - Value to set property to

    • getCopyValueFromItem

      public String getCopyValueFromItem()
      Get text property CopyValueFromItem (COPY_VALUE_FROM_ITEM_PTID).
      Returns:
      Value of property

    • setCopyValueFromItem

      public void setCopyValueFromItem(String value)
      Sets text property CopyValueFromItem (COPY_VALUE_FROM_ITEM_PTID).
      Parameters:
      value - Value to set property to

    • getDataSourceBlock

      public String getDataSourceBlock()
      Get text property DataSourceBlock (DATA_SOURCE_BLOCK_PTID).
      Returns:
      Value of property

    • setDataSourceBlock

      public void setDataSourceBlock(String value)
      Sets text property DataSourceBlock (DATA_SOURCE_BLOCK_PTID).
      Parameters:
      value - Value to set property to

    • getDataSourceXAxis

      public String getDataSourceXAxis()
      Get text property DataSourceXAxis (DATA_SOURCE_X_AXIS_PTID).
      Returns:
      Value of property

    • setDataSourceXAxis

      public void setDataSourceXAxis(String value)
      Sets text property DataSourceXAxis (DATA_SOURCE_X_AXIS_PTID).
      Parameters:
      value - Value to set property to

    • getDataSourceYAxis

      public String getDataSourceYAxis()
      Get text property DataSourceYAxis (DATA_SOURCE_Y_AXIS_PTID).
      Returns:
      Value of property

    • setDataSourceYAxis

      public void setDataSourceYAxis(String value)
      Sets text property DataSourceYAxis (DATA_SOURCE_Y_AXIS_PTID).
      Parameters:
      value - Value to set property to

    • getEditName

      public String getEditName()
      Get text property EditName (EDIT_NAME_PTID).
      Returns:
      Value of property

    • setEditName

      public void setEditName(String value)
      Sets text property EditName (EDIT_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getFillPattern

      public String getFillPattern()
      Get text property FillPattern (FILL_PATTERN_PTID).
      Returns:
      Value of property

    • setFillPattern

      public void setFillPattern(String value)
      Sets text property FillPattern (FILL_PATTERN_PTID).
      Parameters:
      value - Value to set property to

    • getFilename

      public String getFilename()
      Get text property Filename (FILENAME_PTID).
      Returns:
      Value of property

    • setFilename

      public void setFilename(String value)
      Sets text property Filename (FILENAME_PTID).
      Parameters:
      value - Value to set property to

    • getFormatMask

      public String getFormatMask()
      Get text property FormatMask (FORMAT_MASK_PTID).
      Returns:
      Value of property

    • setFormatMask

      public void setFormatMask(String value)
      Sets text property FormatMask (FORMAT_MASK_PTID).
      Parameters:
      value - Value to set property to

    • getFontName

      public String getFontName()
      Get text property FontName (FONT_NAME_PTID).
      Returns:
      Value of property

    • setFontName

      public void setFontName(String value)
      Sets text property FontName (FONT_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getForegroundColor

      public String getForegroundColor()
      Get text property ForegroundColor (FOREGROUND_COLOR_PTID).
      Returns:
      Value of property

    • setForegroundColor

      public void setForegroundColor(String value)
      Sets text property ForegroundColor (FOREGROUND_COLOR_PTID).
      Parameters:
      value - Value to set property to

    • getFormula

      public String getFormula()
      Get text property Formula (FORMULA_PTID).
      Returns:
      Value of property

    • setFormula

      public void setFormula(String value)
      Sets text property Formula (FORMULA_PTID).
      Parameters:
      value - Value to set property to

    • getHelpBookTopic

      public String getHelpBookTopic()
      Get text property HelpBookTopic (HELP_BOOK_TOPIC_PTID).
      Returns:
      Value of property

    • setHelpBookTopic

      public void setHelpBookTopic(String value)
      Sets text property HelpBookTopic (HELP_BOOK_TOPIC_PTID).
      Parameters:
      value - Value to set property to

    • getHighestAllowedValue

      public String getHighestAllowedValue()
      Get text property HighestAllowedValue (HIGHEST_ALLOWED_VALUE_PTID).
      Returns:
      Value of property

    • setHighestAllowedValue

      public void setHighestAllowedValue(String value)
      Sets text property HighestAllowedValue (HIGHEST_ALLOWED_VALUE_PTID).
      Parameters:
      value - Value to set property to

    • getHint

      public String getHint()
      Get text property Hint (HINT_PTID).
      Returns:
      Value of property

    • setHint

      public void setHint(String value)
      Sets text property Hint (HINT_PTID).
      Parameters:
      value - Value to set property to

    • getIconFilename

      public String getIconFilename()
      Get text property IconFilename (ICON_FILENAME_PTID).
      Returns:
      Value of property

    • setIconFilename

      public void setIconFilename(String value)
      Sets text property IconFilename (ICON_FILENAME_PTID).
      Parameters:
      value - Value to set property to

    • getImplementationClass

      public String getImplementationClass()
      Get text property ImplementationClass (IMPLEMENTATION_CLASS_PTID).
      Returns:
      Value of property

    • setImplementationClass

      public void setImplementationClass(String value)
      Sets text property ImplementationClass (IMPLEMENTATION_CLASS_PTID).
      Parameters:
      value - Value to set property to

    • getInitializeValue

      public String getInitializeValue()
      Get text property InitializeValue (INITIALIZE_VALUE_PTID).
      Returns:
      Value of property

    • setInitializeValue

      public void setInitializeValue(String value)
      Sets text property InitializeValue (INITIALIZE_VALUE_PTID).
      Parameters:
      value - Value to set property to

    • getLabel

      public String getLabel()
      Get text property Label (LABEL_PTID).
      Returns:
      Value of property

    • setLabel

      public void setLabel(String value)
      Sets text property Label (LABEL_PTID).
      Parameters:
      value - Value to set property to

    • getLovName

      public String getLovName()
      Get text property LovName (LOV_NAME_PTID).
      Returns:
      Value of property

    • setLovName

      public void setLovName(String value)
      Sets text property LovName (LOV_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getLowestAllowedValue

      public String getLowestAllowedValue()
      Get text property LowestAllowedValue (LOWEST_ALLOWED_VALUE_PTID).
      Returns:
      Value of property

    • setLowestAllowedValue

      public void setLowestAllowedValue(String value)
      Sets text property LowestAllowedValue (LOWEST_ALLOWED_VALUE_PTID).
      Parameters:
      value - Value to set property to

    • getName

      public String getName()
      Get text property Name (NAME_PTID).
      Specified by:
      getName in interface JdapiObject
      Returns:
      Value of property

    • setName

      public void setName(String value)
      Sets text property Name (NAME_PTID).
      Parameters:
      value - Value to set property to

    • getNextNavigationItemName

      public String getNextNavigationItemName()
      Get text property NextNavigationItemName (NEXT_NAVIGATION_ITEM_NAME_PTID).
      Returns:
      Value of property

    • setNextNavigationItemName

      public void setNextNavigationItemName(String value)
      Sets text property NextNavigationItemName (NEXT_NAVIGATION_ITEM_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getOleClass

      public String getOleClass()
      Get text property OleClass (OLE_CLASS_PTID).
      Returns:
      Value of property

    • setOleClass

      public void setOleClass(String value)
      Sets text property OleClass (OLE_CLASS_PTID).
      Parameters:
      value - Value to set property to

    • getOtherValues

      public String getOtherValues()
      Get text property OtherValues (OTHER_VALUES_PTID).
      Returns:
      Value of property

    • setOtherValues

      public void setOtherValues(String value)
      Sets text property OtherValues (OTHER_VALUES_PTID).
      Parameters:
      value - Value to set property to

    • getParentFilename

      public String getParentFilename()
      Get text property ParentFilename (PARENT_FILENAME_PTID).
      Returns:
      Value of property

    • setParentFilename

      public void setParentFilename(String value)
      Sets text property ParentFilename (PARENT_FILENAME_PTID).
      Parameters:
      value - Value to set property to

    • getParentFilepath

      public String getParentFilepath()
      Get text property ParentFilepath (PARENT_FILEPATH_PTID).
      Returns:
      Value of property

    • setParentFilepath

      public void setParentFilepath(String value)
      Sets text property ParentFilepath (PARENT_FILEPATH_PTID).
      Parameters:
      value - Value to set property to

    • getParentModule

      public String getParentModule()
      Get text property ParentModule (PARENT_MODULE_PTID).
      Returns:
      Value of property

    • setParentModule

      public void setParentModule(String value)
      Sets text property ParentModule (PARENT_MODULE_PTID).
      Parameters:
      value - Value to set property to

    • getParentName

      public String getParentName()
      Get text property ParentName (PARENT_NAME_PTID).
      Returns:
      Value of property

    • setParentName

      public void setParentName(String value)
      Sets text property ParentName (PARENT_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getParentSourceLevel1ObjectName

      public String getParentSourceLevel1ObjectName()
      Get text property ParentSourceLevel1ObjectName (PARENT_SOURCELEVEL1OBJECT_NAME_PTID).
      Returns:
      Value of property

    • setParentSourceLevel1ObjectName

      public void setParentSourceLevel1ObjectName(String value)
      Sets text property ParentSourceLevel1ObjectName (PARENT_SOURCELEVEL1OBJECT_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getPlaceholderText

      public String getPlaceholderText()
      Get text property PlaceholderText (PLACEHOLDER_TEXT_PTID).
      Returns:
      Value of property

    • setPlaceholderText

      public void setPlaceholderText(String value)
      Sets text property PlaceholderText (PLACEHOLDER_TEXT_PTID).
      Parameters:
      value - Value to set property to

    • getPopupMenuName

      public String getPopupMenuName()
      Get text property PopupMenuName (POPUP_MENU_NAME_PTID).
      Returns:
      Value of property

    • setPopupMenuName

      public void setPopupMenuName(String value)
      Sets text property PopupMenuName (POPUP_MENU_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getPreviousNavigationItemName

      public String getPreviousNavigationItemName()
      Get text property PreviousNavigationItemName (PREVIOUS_NAVIGATION_ITEM_NAME_PTID).
      Returns:
      Value of property

    • setPreviousNavigationItemName

      public void setPreviousNavigationItemName(String value)
      Sets text property PreviousNavigationItemName (PREVIOUS_NAVIGATION_ITEM_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getPrompt

      public String getPrompt()
      Get text property Prompt (PROMPT_PTID).
      Returns:
      Value of property

    • setPrompt

      public void setPrompt(String value)
      Sets text property Prompt (PROMPT_PTID).
      Parameters:
      value - Value to set property to

    • getPromptBackColor

      public String getPromptBackColor()
      Get text property PromptBackColor (PROMPT_BACK_COLOR_PTID).
      Returns:
      Value of property

    • setPromptBackColor

      public void setPromptBackColor(String value)
      Sets text property PromptBackColor (PROMPT_BACK_COLOR_PTID).
      Parameters:
      value - Value to set property to

    • getPromptFillPattern

      public String getPromptFillPattern()
      Get text property PromptFillPattern (PROMPT_FILL_PATTERN_PTID).
      Returns:
      Value of property

    • setPromptFillPattern

      public void setPromptFillPattern(String value)
      Sets text property PromptFillPattern (PROMPT_FILL_PATTERN_PTID).
      Parameters:
      value - Value to set property to

    • getPromptFontName

      public String getPromptFontName()
      Get text property PromptFontName (PROMPT_FONT_NAME_PTID).
      Returns:
      Value of property

    • setPromptFontName

      public void setPromptFontName(String value)
      Sets text property PromptFontName (PROMPT_FONT_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getPromptForegroundColor

      public String getPromptForegroundColor()
      Get text property PromptForegroundColor (PROMPT_FOREGROUND_COLOR_PTID).
      Returns:
      Value of property

    • setPromptForegroundColor

      public void setPromptForegroundColor(String value)
      Sets text property PromptForegroundColor (PROMPT_FOREGROUND_COLOR_PTID).
      Parameters:
      value - Value to set property to

    • getPromptVisualAttributeName

      public String getPromptVisualAttributeName()
      Get text property PromptVisualAttributeName (PROMPT_VISUALATTRIBUTE_NAME_PTID).
      Returns:
      Value of property

    • setPromptVisualAttributeName

      public void setPromptVisualAttributeName(String value)
      Sets text property PromptVisualAttributeName (PROMPT_VISUALATTRIBUTE_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getQueryName

      public String getQueryName()
      Get text property QueryName (QUERY_NAME_PTID).
      Returns:
      Value of property

    • setQueryName

      public void setQueryName(String value)
      Sets text property QueryName (QUERY_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getRecordGroupName

      public String getRecordGroupName()
      Get text property RecordGroupName (RECORD_GROUP_NAME_PTID).
      Returns:
      Value of property

    • setRecordGroupName

      public void setRecordGroupName(String value)
      Sets text property RecordGroupName (RECORD_GROUP_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getRecordVisualAttributeGroupName

      public String getRecordVisualAttributeGroupName()
      Get text property RecordVisualAttributeGroupName (RECORD_VISUALATTRIBUTE_GROUP_NAME_PTID).
      Returns:
      Value of property

    • setRecordVisualAttributeGroupName

      public void setRecordVisualAttributeGroupName(String value)
      Sets text property RecordVisualAttributeGroupName (RECORD_VISUALATTRIBUTE_GROUP_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getSummaryBlockName

      public String getSummaryBlockName()
      Get text property SummaryBlockName (SUMMARY_BLOCK_NAME_PTID).
      Returns:
      Value of property

    • setSummaryBlockName

      public void setSummaryBlockName(String value)
      Sets text property SummaryBlockName (SUMMARY_BLOCK_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getSummaryItemName

      public String getSummaryItemName()
      Get text property SummaryItemName (SUMMARY_ITEM_NAME_PTID).
      Returns:
      Value of property

    • setSummaryItemName

      public void setSummaryItemName(String value)
      Sets text property SummaryItemName (SUMMARY_ITEM_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getSynchronizedItemName

      public String getSynchronizedItemName()
      Get text property SynchronizedItemName (SYNCHRONIZED_ITEM_NAME_PTID).
      Returns:
      Value of property

    • setSynchronizedItemName

      public void setSynchronizedItemName(String value)
      Sets text property SynchronizedItemName (SYNCHRONIZED_ITEM_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getTabPageName

      public String getTabPageName()
      Get text property TabPageName (TABPAGE_NAME_PTID).
      Returns:
      Value of property

    • setTabPageName

      public void setTabPageName(String value)
      Sets text property TabPageName (TABPAGE_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getTooltip

      public String getTooltip()
      Get text property Tooltip (TOOLTIP_PTID).
      Returns:
      Value of property

    • setTooltip

      public void setTooltip(String value)
      Sets text property Tooltip (TOOLTIP_PTID).
      Parameters:
      value - Value to set property to

    • getTooltipVisualAttributeGroup

      public String getTooltipVisualAttributeGroup()
      Get text property TooltipVisualAttributeGroup (TOOLTIP_VISUALATTRIBUTE_GROUP_PTID).
      Returns:
      Value of property

    • setTooltipVisualAttributeGroup

      public void setTooltipVisualAttributeGroup(String value)
      Sets text property TooltipVisualAttributeGroup (TOOLTIP_VISUALATTRIBUTE_GROUP_PTID).
      Parameters:
      value - Value to set property to

    • getTreeDataQuery

      public String getTreeDataQuery()
      Get text property TreeDataQuery (TREE_DATA_QUERY_PTID).
      Returns:
      Value of property

    • setTreeDataQuery

      public void setTreeDataQuery(String value)
      Sets text property TreeDataQuery (TREE_DATA_QUERY_PTID).
      Parameters:
      value - Value to set property to

    • getUncheckedValue

      public String getUncheckedValue()
      Get text property UncheckedValue (UNCHECKED_VALUE_PTID).
      Returns:
      Value of property

    • setUncheckedValue

      public void setUncheckedValue(String value)
      Sets text property UncheckedValue (UNCHECKED_VALUE_PTID).
      Parameters:
      value - Value to set property to

    • getVisualAttributeName

      public String getVisualAttributeName()
      Get text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).
      Returns:
      Value of property

    • setVisualAttributeName

      public void setVisualAttributeName(String value)
      Sets text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).
      Parameters:
      value - Value to set property to

    • getAudioChannels

      public int getAudioChannels()
      Get number property AudioChannels (AUDIO_CHANNELS_PTID).
      Returns:
      Value of property

    • setAudioChannels

      public void setAudioChannels(int value)
      Sets number property AudioChannels (AUDIO_CHANNELS_PTID).
      Parameters:
      value - Value to set property to

    • getBevel

      public int getBevel()
      Get number property Bevel (BEVEL_PTID).
      Returns:
      Value of property

    • setBevel

      public void setBevel(int value)
      Sets number property Bevel (BEVEL_PTID).
      Parameters:
      value - Value to set property to

    • getCalculateMode

      public int getCalculateMode()
      Get number property CalculateMode (CALCULATE_MODE_PTID).
      Returns:
      Value of property

    • setCalculateMode

      public void setCalculateMode(int value)
      Sets number property CalculateMode (CALCULATE_MODE_PTID).
      Parameters:
      value - Value to set property to

    • getCaseRestriction

      public int getCaseRestriction()
      Get number property CaseRestriction (CASE_RESTRICTION_PTID).
      Returns:
      Value of property

    • setCaseRestriction

      public void setCaseRestriction(int value)
      Sets number property CaseRestriction (CASE_RESTRICTION_PTID).
      Parameters:
      value - Value to set property to

    • getCheckBoxOtherValues

      public int getCheckBoxOtherValues()
      Get number property CheckBoxOtherValues (CHECK_BOX_OTHER_VALUES_PTID).
      Returns:
      Value of property

    • setCheckBoxOtherValues

      public void setCheckBoxOtherValues(int value)
      Sets number property CheckBoxOtherValues (CHECK_BOX_OTHER_VALUES_PTID).
      Parameters:
      value - Value to set property to

    • getCompressionQuality

      public int getCompressionQuality()
      Get number property CompressionQuality (COMPRESSION_QUALITY_PTID).
      Returns:
      Value of property

    • setCompressionQuality

      public void setCompressionQuality(int value)
      Sets number property CompressionQuality (COMPRESSION_QUALITY_PTID).
      Parameters:
      value - Value to set property to

    • getCommMode

      public int getCommMode()
      Get number property CommMode (COMM_MODE_PTID).
      Returns:
      Value of property

    • setCommMode

      public void setCommMode(int value)
      Sets number property CommMode (COMM_MODE_PTID).
      Parameters:
      value - Value to set property to

    • getCompress

      public int getCompress()
      Get number property Compress (COMPRESS_PTID).
      Returns:
      Value of property

    • setCompress

      public void setCompress(int value)
      Sets number property Compress (COMPRESS_PTID).
      Parameters:
      value - Value to set property to

    • getCursorStyle

      public int getCursorStyle()
      Get number property CursorStyle (CURSOR_STYLE_PTID).
      Returns:
      Value of property

    • setCursorStyle

      public void setCursorStyle(int value)
      Sets number property CursorStyle (CURSOR_STYLE_PTID).
      Parameters:
      value - Value to set property to

    • getDataType

      public int getDataType()
      Get number property DataType (DATA_TYPE_PTID).
      Returns:
      Value of property

    • setDataType

      public void setDataType(int value)
      Sets number property DataType (DATA_TYPE_PTID).
      Parameters:
      value - Value to set property to

    • getDataLengthSemantics

      public int getDataLengthSemantics()
      Get number property DataLengthSemantics (DATA_LENGTH_SEMANTICS_PTID).
      Returns:
      Value of property

    • setDataLengthSemantics

      public void setDataLengthSemantics(int value)
      Sets number property DataLengthSemantics (DATA_LENGTH_SEMANTICS_PTID).
      Parameters:
      value - Value to set property to

    • getDisplayQuality

      public int getDisplayQuality()
      Get number property DisplayQuality (DISPLAY_QUALITY_PTID).
      Returns:
      Value of property

    • setDisplayQuality

      public void setDisplayQuality(int value)
      Sets number property DisplayQuality (DISPLAY_QUALITY_PTID).
      Parameters:
      value - Value to set property to

    • getDisplayUiStyle

      public int getDisplayUiStyle()
      Get number property DisplayUiStyle (DISPLAY_UI_STYLE_PTID).
      Returns:
      Value of property

    • setDisplayUiStyle

      public void setDisplayUiStyle(int value)
      Sets number property DisplayUiStyle (DISPLAY_UI_STYLE_PTID).
      Parameters:
      value - Value to set property to

    • getDistanceBetweenRecords

      public int getDistanceBetweenRecords()
      Get number property DistanceBetweenRecords (DISTANCE_BETWEEN_RECORDS_PTID).
      Returns:
      Value of property

    • setDistanceBetweenRecords

      public void setDistanceBetweenRecords(int value)
      Sets number property DistanceBetweenRecords (DISTANCE_BETWEEN_RECORDS_PTID).
      Parameters:
      value - Value to set property to

    • getEditXPosition

      public int getEditXPosition()
      Get number property EditXPosition (EDIT_X_POSITION_PTID).
      Returns:
      Value of property

    • setEditXPosition

      public void setEditXPosition(int value)
      Sets number property EditXPosition (EDIT_X_POSITION_PTID).
      Parameters:
      value - Value to set property to

    • getEditYPosition

      public int getEditYPosition()
      Get number property EditYPosition (EDIT_Y_POSITION_PTID).
      Returns:
      Value of property

    • setEditYPosition

      public void setEditYPosition(int value)
      Sets number property EditYPosition (EDIT_Y_POSITION_PTID).
      Parameters:
      value - Value to set property to

    • getExecuteMode

      public int getExecuteMode()
      Get number property ExecuteMode (EXECUTE_MODE_PTID).
      Returns:
      Value of property

    • setExecuteMode

      public void setExecuteMode(int value)
      Sets number property ExecuteMode (EXECUTE_MODE_PTID).
      Parameters:
      value - Value to set property to

    • getFontSize

      public int getFontSize()
      Get number property FontSize (FONT_SIZE_PTID).
      Returns:
      Value of property

    • setFontSize

      public void setFontSize(int value)
      Sets number property FontSize (FONT_SIZE_PTID).
      Parameters:
      value - Value to set property to

    • getFontSpacing

      public int getFontSpacing()
      Get number property FontSpacing (FONT_SPACING_PTID).
      Returns:
      Value of property

    • setFontSpacing

      public void setFontSpacing(int value)
      Sets number property FontSpacing (FONT_SPACING_PTID).
      Parameters:
      value - Value to set property to

    • getFontStyle

      public int getFontStyle()
      Get number property FontStyle (FONT_STYLE_PTID).
      Returns:
      Value of property

    • setFontStyle

      public void setFontStyle(int value)
      Sets number property FontStyle (FONT_STYLE_PTID).
      Parameters:
      value - Value to set property to

    • getFontWeight

      public int getFontWeight()
      Get number property FontWeight (FONT_WEIGHT_PTID).
      Returns:
      Value of property

    • setFontWeight

      public void setFontWeight(int value)
      Sets number property FontWeight (FONT_WEIGHT_PTID).
      Parameters:
      value - Value to set property to

    • getForegroundColorMode

      public int getForegroundColorMode()
      Get number property ForegroundColorMode (FOREGROUND_COLOR_MODE_PTID).
      Returns:
      Value of property

    • setForegroundColorMode

      public void setForegroundColorMode(int value)
      Sets number property ForegroundColorMode (FOREGROUND_COLOR_MODE_PTID).
      Parameters:
      value - Value to set property to

    • getGradientStart

      public int getGradientStart()
      Get number property GradientStart (GRADIENT_START_PTID).
      Returns:
      Value of property

    • setGradientStart

      public void setGradientStart(int value)
      Sets number property GradientStart (GRADIENT_START_PTID).
      Parameters:
      value - Value to set property to

    • getHeight

      public int getHeight()
      Get number property Height (HEIGHT_PTID).
      Returns:
      Value of property

    • setHeight

      public void setHeight(int value)
      Sets number property Height (HEIGHT_PTID).
      Parameters:
      value - Value to set property to

    • getImageDepth

      public int getImageDepth()
      Get number property ImageDepth (IMAGE_DEPTH_PTID).
      Returns:
      Value of property

    • setImageDepth

      public void setImageDepth(int value)
      Sets number property ImageDepth (IMAGE_DEPTH_PTID).
      Parameters:
      value - Value to set property to

    • getImageFormat

      public int getImageFormat()
      Get number property ImageFormat (IMAGE_FORMAT_PTID).
      Returns:
      Value of property

    • setImageFormat

      public void setImageFormat(int value)
      Sets number property ImageFormat (IMAGE_FORMAT_PTID).
      Parameters:
      value - Value to set property to

    • getInitializeKeyboardDirection

      public int getInitializeKeyboardDirection()
      Get number property InitializeKeyboardDirection (INITIALIZE_KEYBOARD_DIRECTION_PTID).
      Returns:
      Value of property

    • setInitializeKeyboardDirection

      public void setInitializeKeyboardDirection(int value)
      Sets number property InitializeKeyboardDirection (INITIALIZE_KEYBOARD_DIRECTION_PTID).
      Parameters:
      value - Value to set property to

    • getItemRecordOrientation

      public int getItemRecordOrientation()
      Get number property ItemRecordOrientation (ITEM_RECORD_ORIENTATION_PTID).
      Returns:
      Value of property

    • setItemRecordOrientation

      public void setItemRecordOrientation(int value)
      Sets number property ItemRecordOrientation (ITEM_RECORD_ORIENTATION_PTID).
      Parameters:
      value - Value to set property to

    • getItemType

      public int getItemType()
      Get number property ItemType (ITEM_TYPE_PTID).
      Returns:
      Value of property

    • setItemType

      public void setItemType(int value)
      Sets number property ItemType (ITEM_TYPE_PTID).
      Parameters:
      value - Value to set property to

    • getItemsDisplay

      public int getItemsDisplay()
      Get number property ItemsDisplay (ITEMS_DISPLAY_PTID).
      Returns:
      Value of property

    • setItemsDisplay

      public void setItemsDisplay(int value)
      Sets number property ItemsDisplay (ITEMS_DISPLAY_PTID).
      Parameters:
      value - Value to set property to

    • getJustification

      public int getJustification()
      Get number property Justification (JUSTIFICATION_PTID).
      Returns:
      Value of property

    • setJustification

      public void setJustification(int value)
      Sets number property Justification (JUSTIFICATION_PTID).
      Parameters:
      value - Value to set property to

    • getKeyboardState

      public int getKeyboardState()
      Get number property KeyboardState (KEYBOARD_STATE_PTID).
      Returns:
      Value of property

    • setKeyboardState

      public void setKeyboardState(int value)
      Sets number property KeyboardState (KEYBOARD_STATE_PTID).
      Parameters:
      value - Value to set property to

    • getLabelWithIcon

      public int getLabelWithIcon()
      Get number property LabelWithIcon (LABEL_WITH_ICON_PTID).
      Returns:
      Value of property

    • setLabelWithIcon

      public void setLabelWithIcon(int value)
      Sets number property LabelWithIcon (LABEL_WITH_ICON_PTID).
      Parameters:
      value - Value to set property to

    • getLanguageDirection

      public int getLanguageDirection()
      Get number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
      Returns:
      Value of property

    • setLanguageDirection

      public void setLanguageDirection(int value)
      Sets number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
      Parameters:
      value - Value to set property to

    • getLovXPosition

      public int getLovXPosition()
      Get number property LovXPosition (LOV_X_POSITION_PTID).
      Returns:
      Value of property

    • setLovXPosition

      public void setLovXPosition(int value)
      Sets number property LovXPosition (LOV_X_POSITION_PTID).
      Parameters:
      value - Value to set property to

    • getLovYPosition

      public int getLovYPosition()
      Get number property LovYPosition (LOV_Y_POSITION_PTID).
      Returns:
      Value of property

    • setLovYPosition

      public void setLovYPosition(int value)
      Sets number property LovYPosition (LOV_Y_POSITION_PTID).
      Parameters:
      value - Value to set property to

    • getListElementCount

      public int getListElementCount()
      Get number property ListElementCount (LIST_ELEMENT_COUNT_PTID).
      Returns:
      Value of property

    • getListStyle

      public int getListStyle()
      Get number property ListStyle (LIST_STYLE_PTID).
      Returns:
      Value of property

    • setListStyle

      public void setListStyle(int value)
      Sets number property ListStyle (LIST_STYLE_PTID).
      Parameters:
      value - Value to set property to

    • getMaximumLength

      public int getMaximumLength()
      Get number property MaximumLength (MAXIMUM_LENGTH_PTID).
      Returns:
      Value of property

    • setMaximumLength

      public void setMaximumLength(int value)
      Sets number property MaximumLength (MAXIMUM_LENGTH_PTID).
      Parameters:
      value - Value to set property to

    • getOleActionStyle

      public int getOleActionStyle()
      Get number property OleActionStyle (OLE_ACTION_STYLE_PTID).
      Returns:
      Value of property

    • setOleActionStyle

      public void setOleActionStyle(int value)
      Sets number property OleActionStyle (OLE_ACTION_STYLE_PTID).
      Parameters:
      value - Value to set property to

    • getOlePopupMenuItems

      public int getOlePopupMenuItems()
      Get number property OlePopupMenuItems (OLE_POPUP_MENU_ITEMS_PTID).
      Returns:
      Value of property

    • setOlePopupMenuItems

      public void setOlePopupMenuItems(int value)
      Sets number property OlePopupMenuItems (OLE_POPUP_MENU_ITEMS_PTID).
      Parameters:
      value - Value to set property to

    • getOleResizStyle

      public int getOleResizStyle()
      Get number property OleResizStyle (OLE_RESIZ_STYLE_PTID).
      Returns:
      Value of property

    • setOleResizStyle

      public void setOleResizStyle(int value)
      Sets number property OleResizStyle (OLE_RESIZ_STYLE_PTID).
      Parameters:
      value - Value to set property to

    • getOleTenantTypeAspect

      public int getOleTenantTypeAspect()
      Get number property OleTenantTypeAspect (OLE_TENANTTYPE_ASPECT_PTID).
      Returns:
      Value of property

    • setOleTenantTypeAspect

      public void setOleTenantTypeAspect(int value)
      Sets number property OleTenantTypeAspect (OLE_TENANTTYPE_ASPECT_PTID).
      Parameters:
      value - Value to set property to

    • getOleTenantTypeType

      public int getOleTenantTypeType()
      Get number property OleTenantTypeType (OLE_TENANTTYPE_TYPE_PTID).
      Returns:
      Value of property

    • setOleTenantTypeType

      public void setOleTenantTypeType(int value)
      Sets number property OleTenantTypeType (OLE_TENANTTYPE_TYPE_PTID).
      Parameters:
      value - Value to set property to

    • getParentModuleType

      public int getParentModuleType()
      Get number property ParentModuleType (PARENT_MODULETYPE_PTID).
      Returns:
      Value of property

    • setParentModuleType

      public void setParentModuleType(int value)
      Sets number property ParentModuleType (PARENT_MODULETYPE_PTID).
      Parameters:
      value - Value to set property to

    • getParentSourceLevel1ObjectType

      public int getParentSourceLevel1ObjectType()
      Get number property ParentSourceLevel1ObjectType (PARENT_SOURCELEVEL1OBJECT_TYPE_PTID).
      Returns:
      Value of property

    • setParentSourceLevel1ObjectType

      public void setParentSourceLevel1ObjectType(int value)
      Sets number property ParentSourceLevel1ObjectType (PARENT_SOURCELEVEL1OBJECT_TYPE_PTID).
      Parameters:
      value - Value to set property to

    • getParentType

      public int getParentType()
      Get number property ParentType (PARENT_TYPE_PTID).
      Returns:
      Value of property

    • setParentType

      public void setParentType(int value)
      Sets number property ParentType (PARENT_TYPE_PTID).
      Parameters:
      value - Value to set property to

    • getPersistentClientInfoLength

      public int getPersistentClientInfoLength()
      Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
      Returns:
      Value of property

    • setPersistentClientInfoLength

      public void setPersistentClientInfoLength(int value)
      Sets number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
      Parameters:
      value - Value to set property to

    • getPromptAlign

      public int getPromptAlign()
      Get number property PromptAlign (PROMPT_ALIGN_PTID).
      Returns:
      Value of property

    • setPromptAlign

      public void setPromptAlign(int value)
      Sets number property PromptAlign (PROMPT_ALIGN_PTID).
      Parameters:
      value - Value to set property to

    • getPromptAlignOffset

      public int getPromptAlignOffset()
      Get number property PromptAlignOffset (PROMPT_ALIGN_OFFSET_PTID).
      Returns:
      Value of property

    • setPromptAlignOffset

      public void setPromptAlignOffset(int value)
      Sets number property PromptAlignOffset (PROMPT_ALIGN_OFFSET_PTID).
      Parameters:
      value - Value to set property to

    • getPromptAttachmentEdge

      public int getPromptAttachmentEdge()
      Get number property PromptAttachmentEdge (PROMPT_ATTACHMENT_EDGE_PTID).
      Returns:
      Value of property

    • setPromptAttachmentEdge

      public void setPromptAttachmentEdge(int value)
      Sets number property PromptAttachmentEdge (PROMPT_ATTACHMENT_EDGE_PTID).
      Parameters:
      value - Value to set property to

    • getPromptAttachmentOffset

      public int getPromptAttachmentOffset()
      Get number property PromptAttachmentOffset (PROMPT_ATTACHMENT_OFFSET_PTID).
      Returns:
      Value of property

    • setPromptAttachmentOffset

      public void setPromptAttachmentOffset(int value)
      Sets number property PromptAttachmentOffset (PROMPT_ATTACHMENT_OFFSET_PTID).
      Parameters:
      value - Value to set property to

    • getPromptDisplayStyle

      public int getPromptDisplayStyle()
      Get number property PromptDisplayStyle (PROMPT_DISPLAY_STYLE_PTID).
      Returns:
      Value of property

    • setPromptDisplayStyle

      public void setPromptDisplayStyle(int value)
      Sets number property PromptDisplayStyle (PROMPT_DISPLAY_STYLE_PTID).
      Parameters:
      value - Value to set property to

    • getPromptFontSize

      public int getPromptFontSize()
      Get number property PromptFontSize (PROMPT_FONT_SIZE_PTID).
      Returns:
      Value of property

    • setPromptFontSize

      public void setPromptFontSize(int value)
      Sets number property PromptFontSize (PROMPT_FONT_SIZE_PTID).
      Parameters:
      value - Value to set property to

    • getPromptFontSpacing

      public int getPromptFontSpacing()
      Get number property PromptFontSpacing (PROMPT_FONT_SPACING_PTID).
      Returns:
      Value of property

    • setPromptFontSpacing

      public void setPromptFontSpacing(int value)
      Sets number property PromptFontSpacing (PROMPT_FONT_SPACING_PTID).
      Parameters:
      value - Value to set property to

    • getPromptFontStyle

      public int getPromptFontStyle()
      Get number property PromptFontStyle (PROMPT_FONT_STYLE_PTID).
      Returns:
      Value of property

    • setPromptFontStyle

      public void setPromptFontStyle(int value)
      Sets number property PromptFontStyle (PROMPT_FONT_STYLE_PTID).
      Parameters:
      value - Value to set property to

    • getPromptFontWeight

      public int getPromptFontWeight()
      Get number property PromptFontWeight (PROMPT_FONT_WEIGHT_PTID).
      Returns:
      Value of property

    • setPromptFontWeight

      public void setPromptFontWeight(int value)
      Sets number property PromptFontWeight (PROMPT_FONT_WEIGHT_PTID).
      Parameters:
      value - Value to set property to

    • getPromptJustification

      public int getPromptJustification()
      Get number property PromptJustification (PROMPT_JUSTIFICATION_PTID).
      Returns:
      Value of property

    • setPromptJustification

      public void setPromptJustification(int value)
      Sets number property PromptJustification (PROMPT_JUSTIFICATION_PTID).
      Parameters:
      value - Value to set property to

    • getPromptReadingOrder

      public int getPromptReadingOrder()
      Get number property PromptReadingOrder (PROMPT_READING_ORDER_PTID).
      Returns:
      Value of property

    • setPromptReadingOrder

      public void setPromptReadingOrder(int value)
      Sets number property PromptReadingOrder (PROMPT_READING_ORDER_PTID).
      Parameters:
      value - Value to set property to

    • getProgbarOrientation

      public int getProgbarOrientation()
      Get number property ProgbarOrientation (PROGBAR_ORIENTATION_PTID).
      Returns:
      Value of property

    • setProgbarOrientation

      public void setProgbarOrientation(int value)
      Sets number property ProgbarOrientation (PROGBAR_ORIENTATION_PTID).
      Parameters:
      value - Value to set property to

    • getQueryLength

      public int getQueryLength()
      Get number property QueryLength (QUERY_LENGTH_PTID).
      Returns:
      Value of property

    • setQueryLength

      public void setQueryLength(int value)
      Sets number property QueryLength (QUERY_LENGTH_PTID).
      Parameters:
      value - Value to set property to

    • getReadingOrder

      public int getReadingOrder()
      Get number property ReadingOrder (READING_ORDER_PTID).
      Returns:
      Value of property

    • setReadingOrder

      public void setReadingOrder(int value)
      Sets number property ReadingOrder (READING_ORDER_PTID).
      Parameters:
      value - Value to set property to

    • getRoundSide

      public int getRoundSide()
      Get number property RoundSide (ROUND_SIDE_PTID).
      Returns:
      Value of property

    • setRoundSide

      public void setRoundSide(int value)
      Sets number property RoundSide (ROUND_SIDE_PTID).
      Parameters:
      value - Value to set property to

    • getRowBandingFreq

      public int getRowBandingFreq()
      Get number property RowBandingFreq (ROW_BANDING_FREQ_PTID).
      Returns:
      Value of property

    • setRowBandingFreq

      public void setRowBandingFreq(int value)
      Sets number property RowBandingFreq (ROW_BANDING_FREQ_PTID).
      Parameters:
      value - Value to set property to

    • getSizingStyle

      public int getSizingStyle()
      Get number property SizingStyle (SIZING_STYLE_PTID).
      Returns:
      Value of property

    • setSizingStyle

      public void setSizingStyle(int value)
      Sets number property SizingStyle (SIZING_STYLE_PTID).
      Parameters:
      value - Value to set property to

    • getSoundFormat

      public int getSoundFormat()
      Get number property SoundFormat (SOUND_FORMAT_PTID).
      Returns:
      Value of property

    • setSoundFormat

      public void setSoundFormat(int value)
      Sets number property SoundFormat (SOUND_FORMAT_PTID).
      Parameters:
      value - Value to set property to

    • getSoundQuality

      public int getSoundQuality()
      Get number property SoundQuality (SOUND_QUALITY_PTID).
      Returns:
      Value of property

    • setSoundQuality

      public void setSoundQuality(int value)
      Sets number property SoundQuality (SOUND_QUALITY_PTID).
      Parameters:
      value - Value to set property to

    • getSummaryFunction

      public int getSummaryFunction()
      Get number property SummaryFunction (SUMMARY_FUNCTION_PTID).
      Returns:
      Value of property

    • setSummaryFunction

      public void setSummaryFunction(int value)
      Sets number property SummaryFunction (SUMMARY_FUNCTION_PTID).
      Parameters:
      value - Value to set property to

    • getUiIncrement

      public int getUiIncrement()
      Get number property UiIncrement (UI_INCREMENT_PTID).
      Returns:
      Value of property

    • setUiIncrement

      public void setUiIncrement(int value)
      Sets number property UiIncrement (UI_INCREMENT_PTID).
      Parameters:
      value - Value to set property to

    • getUiMaxval

      public int getUiMaxval()
      Get number property UiMaxval (UI_MAXVAL_PTID).
      Returns:
      Value of property

    • setUiMaxval

      public void setUiMaxval(int value)
      Sets number property UiMaxval (UI_MAXVAL_PTID).
      Parameters:
      value - Value to set property to

    • getUiMinval

      public int getUiMinval()
      Get number property UiMinval (UI_MINVAL_PTID).
      Returns:
      Value of property

    • setUiMinval

      public void setUiMinval(int value)
      Sets number property UiMinval (UI_MINVAL_PTID).
      Parameters:
      value - Value to set property to

    • getUiStyle

      public int getUiStyle()
      Get number property UiStyle (UI_STYLE_PTID).
      Returns:
      Value of property

    • setUiStyle

      public void setUiStyle(int value)
      Sets number property UiStyle (UI_STYLE_PTID).
      Parameters:
      value - Value to set property to

    • getWidth

      public int getWidth()
      Get number property Width (WIDTH_PTID).
      Returns:
      Value of property

    • setWidth

      public void setWidth(int value)
      Sets number property Width (WIDTH_PTID).
      Parameters:
      value - Value to set property to

    • getWrapStyle

      public int getWrapStyle()
      Get number property WrapStyle (WRAP_STYLE_PTID).
      Returns:
      Value of property

    • setWrapStyle

      public void setWrapStyle(int value)
      Sets number property WrapStyle (WRAP_STYLE_PTID).
      Parameters:
      value - Value to set property to

    • getXPosition

      public int getXPosition()
      Get number property XPosition (X_POSITION_PTID).
      Returns:
      Value of property

    • setXPosition

      public void setXPosition(int value)
      Sets number property XPosition (X_POSITION_PTID).
      Parameters:
      value - Value to set property to

    • getYPosition

      public int getYPosition()
      Get number property YPosition (Y_POSITION_PTID).
      Returns:
      Value of property

    • setYPosition

      public void setYPosition(int value)
      Sets number property YPosition (Y_POSITION_PTID).
      Parameters:
      value - Value to set property to

    • isAnimated

      public boolean isAnimated()
      Get boolean property Animated (ANIMATED_PTID).
      Returns:
      Value of property

    • setAnimated

      public void setAnimated(boolean value)
      Sets boolean property Animated (ANIMATED_PTID).
      Parameters:
      value - Value to set property to

    • isAutoComplete

      public boolean isAutoComplete()
      Get boolean property AutoComplete (AUTO_COMPLETE_PTID).
      Returns:
      Value of property

    • setAutoComplete

      public void setAutoComplete(boolean value)
      Sets boolean property AutoComplete (AUTO_COMPLETE_PTID).
      Parameters:
      value - Value to set property to

    • isAutoHint

      public boolean isAutoHint()
      Get boolean property AutoHint (AUTO_HINT_PTID).
      Returns:
      Value of property

    • setAutoHint

      public void setAutoHint(boolean value)
      Sets boolean property AutoHint (AUTO_HINT_PTID).
      Parameters:
      value - Value to set property to

    • isAutoSkip

      public boolean isAutoSkip()
      Get boolean property AutoSkip (AUTO_SKIP_PTID).
      Returns:
      Value of property

    • setAutoSkip

      public void setAutoSkip(boolean value)
      Sets boolean property AutoSkip (AUTO_SKIP_PTID).
      Parameters:
      value - Value to set property to

    • isBorderColor

      public boolean isBorderColor()
      Get boolean property BorderColor (BORDER_COLOR_PTID).
      Returns:
      Value of property

    • setBorderColor

      public void setBorderColor(boolean value)
      Sets boolean property BorderColor (BORDER_COLOR_PTID).
      Parameters:
      value - Value to set property to

    • isBorderSides

      public boolean isBorderSides()
      Get boolean property BorderSides (BORDER_SIDES_PTID).
      Returns:
      Value of property

    • setBorderSides

      public void setBorderSides(boolean value)
      Sets boolean property BorderSides (BORDER_SIDES_PTID).
      Parameters:
      value - Value to set property to

    • isCaseInsensitiveQuery

      public boolean isCaseInsensitiveQuery()
      Get boolean property CaseInsensitiveQuery (CASE_INSENSITIVE_QUERY_PTID).
      Returns:
      Value of property

    • setCaseInsensitiveQuery

      public void setCaseInsensitiveQuery(boolean value)
      Sets boolean property CaseInsensitiveQuery (CASE_INSENSITIVE_QUERY_PTID).
      Parameters:
      value - Value to set property to

    • isCharacterCounter

      public boolean isCharacterCounter()
      Get boolean property CharacterCounter (CHARACTER_COUNTER_PTID).
      Returns:
      Value of property

    • setCharacterCounter

      public void setCharacterCounter(boolean value)
      Sets boolean property CharacterCounter (CHARACTER_COUNTER_PTID).
      Parameters:
      value - Value to set property to

    • isConcealData

      public boolean isConcealData()
      Get boolean property ConcealData (CONCEAL_DATA_PTID).
      Returns:
      Value of property

    • setConcealData

      public void setConcealData(boolean value)
      Sets boolean property ConcealData (CONCEAL_DATA_PTID).
      Parameters:
      value - Value to set property to

    • isDatabaseItem

      public boolean isDatabaseItem()
      Get boolean property DatabaseItem (DATABASE_ITEM_PTID).
      Returns:
      Value of property

    • setDatabaseItem

      public void setDatabaseItem(boolean value)
      Sets boolean property DatabaseItem (DATABASE_ITEM_PTID).
      Parameters:
      value - Value to set property to

    • isDefaultButton

      public boolean isDefaultButton()
      Get boolean property DefaultButton (DEFAULT_BUTTON_PTID).
      Returns:
      Value of property

    • setDefaultButton

      public void setDefaultButton(boolean value)
      Sets boolean property DefaultButton (DEFAULT_BUTTON_PTID).
      Parameters:
      value - Value to set property to

    • isDirtyInfo

      public boolean isDirtyInfo()
      Get boolean property DirtyInfo (DIRTY_INFO_PTID).
      Returns:
      Value of property

    • setDirtyInfo

      public void setDirtyInfo(boolean value)
      Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
      Parameters:
      value - Value to set property to

    • isDisplayPercentage

      public boolean isDisplayPercentage()
      Get boolean property DisplayPercentage (DISPLAY_PERCENTAGE_PTID).
      Returns:
      Value of property

    • setDisplayPercentage

      public void setDisplayPercentage(boolean value)
      Sets boolean property DisplayPercentage (DISPLAY_PERCENTAGE_PTID).
      Parameters:
      value - Value to set property to

    • isEnabled

      public boolean isEnabled()
      Get boolean property Enabled (ENABLED_PTID).
      Returns:
      Value of property

    • setEnabled

      public void setEnabled(boolean value)
      Sets boolean property Enabled (ENABLED_PTID).
      Parameters:
      value - Value to set property to

    • isFixedLength

      public boolean isFixedLength()
      Get boolean property FixedLength (FIXED_LENGTH_PTID).
      Returns:
      Value of property

    • setFixedLength

      public void setFixedLength(boolean value)
      Sets boolean property FixedLength (FIXED_LENGTH_PTID).
      Parameters:
      value - Value to set property to

    • isIconic

      public boolean isIconic()
      Get boolean property Iconic (ICONIC_PTID).
      Returns:
      Value of property

    • setIconic

      public void setIconic(boolean value)
      Sets boolean property Iconic (ICONIC_PTID).
      Parameters:
      value - Value to set property to

    • isInsertAllowed

      public boolean isInsertAllowed()
      Get boolean property InsertAllowed (INSERT_ALLOWED_PTID).
      Returns:
      Value of property

    • setInsertAllowed

      public void setInsertAllowed(boolean value)
      Sets boolean property InsertAllowed (INSERT_ALLOWED_PTID).
      Parameters:
      value - Value to set property to

    • isKeyboardNavigable

      public boolean isKeyboardNavigable()
      Get boolean property KeyboardNavigable (KEYBOARD_NAVIGABLE_PTID).
      Returns:
      Value of property

    • setKeyboardNavigable

      public void setKeyboardNavigable(boolean value)
      Sets boolean property KeyboardNavigable (KEYBOARD_NAVIGABLE_PTID).
      Parameters:
      value - Value to set property to

    • isKeepCursorPosition

      public boolean isKeepCursorPosition()
      Get boolean property KeepCursorPosition (KEEP_CURSOR_POSITION_PTID).
      Returns:
      Value of property

    • setKeepCursorPosition

      public void setKeepCursorPosition(boolean value)
      Sets boolean property KeepCursorPosition (KEEP_CURSOR_POSITION_PTID).
      Parameters:
      value - Value to set property to

    • isLockRecord

      public boolean isLockRecord()
      Get boolean property LockRecord (LOCK_RECORD_PTID).
      Returns:
      Value of property

    • setLockRecord

      public void setLockRecord(boolean value)
      Sets boolean property LockRecord (LOCK_RECORD_PTID).
      Parameters:
      value - Value to set property to

    • isLovButton

      public boolean isLovButton()
      Get boolean property LovButton (LOV_BUTTON_PTID).
      Returns:
      Value of property

    • setLovButton

      public void setLovButton(boolean value)
      Sets boolean property LovButton (LOV_BUTTON_PTID).
      Parameters:
      value - Value to set property to

    • isMultiLine

      public boolean isMultiLine()
      Get boolean property MultiLine (MULTI_LINE_PTID).
      Returns:
      Value of property

    • setMultiLine

      public void setMultiLine(boolean value)
      Sets boolean property MultiLine (MULTI_LINE_PTID).
      Parameters:
      value - Value to set property to

    • isMouseNavigate

      public boolean isMouseNavigate()
      Get boolean property MouseNavigate (MOUSE_NAVIGATE_PTID).
      Returns:
      Value of property

    • setMouseNavigate

      public void setMouseNavigate(boolean value)
      Sets boolean property MouseNavigate (MOUSE_NAVIGATE_PTID).
      Parameters:
      value - Value to set property to

    • isOleInPlaceAction

      public boolean isOleInPlaceAction()
      Get boolean property OleInPlaceAction (OLE_IN_PLACE_ACTION_PTID).
      Returns:
      Value of property

    • setOleInPlaceAction

      public void setOleInPlaceAction(boolean value)
      Sets boolean property OleInPlaceAction (OLE_IN_PLACE_ACTION_PTID).
      Parameters:
      value - Value to set property to

    • isOleInsideOutSupport

      public boolean isOleInsideOutSupport()
      Get boolean property OleInsideOutSupport (OLE_INSIDE_OUT_SUPPORT_PTID).
      Returns:
      Value of property

    • setOleInsideOutSupport

      public void setOleInsideOutSupport(boolean value)
      Sets boolean property OleInsideOutSupport (OLE_INSIDE_OUT_SUPPORT_PTID).
      Parameters:
      value - Value to set property to

    • isOleShowPopupMenu

      public boolean isOleShowPopupMenu()
      Get boolean property OleShowPopupMenu (OLE_SHOW_POPUP_MENU_PTID).
      Returns:
      Value of property

    • setOleShowPopupMenu

      public void setOleShowPopupMenu(boolean value)
      Sets boolean property OleShowPopupMenu (OLE_SHOW_POPUP_MENU_PTID).
      Parameters:
      value - Value to set property to

    • isOleShowTenantTypeType

      public boolean isOleShowTenantTypeType()
      Get boolean property OleShowTenantTypeType (OLE_SHOW_TENANTTYPE_TYPE_PTID).
      Returns:
      Value of property

    • setOleShowTenantTypeType

      public void setOleShowTenantTypeType(boolean value)
      Sets boolean property OleShowTenantTypeType (OLE_SHOW_TENANTTYPE_TYPE_PTID).
      Parameters:
      value - Value to set property to

    • isPersistentPlaceholder

      public boolean isPersistentPlaceholder()
      Get boolean property PersistentPlaceholder (PERSISTENT_PLACEHOLDER_PTID).
      Returns:
      Value of property

    • setPersistentPlaceholder

      public void setPersistentPlaceholder(boolean value)
      Sets boolean property PersistentPlaceholder (PERSISTENT_PLACEHOLDER_PTID).
      Parameters:
      value - Value to set property to

    • isPrimaryKey

      public boolean isPrimaryKey()
      Get boolean property PrimaryKey (PRIMARY_KEY_PTID).
      Returns:
      Value of property

    • setPrimaryKey

      public void setPrimaryKey(boolean value)
      Sets boolean property PrimaryKey (PRIMARY_KEY_PTID).
      Parameters:
      value - Value to set property to

    • isQueryAllowed

      public boolean isQueryAllowed()
      Get boolean property QueryAllowed (QUERY_ALLOWED_PTID).
      Returns:
      Value of property

    • setQueryAllowed

      public void setQueryAllowed(boolean value)
      Sets boolean property QueryAllowed (QUERY_ALLOWED_PTID).
      Parameters:
      value - Value to set property to

    • isQueryOnly

      public boolean isQueryOnly()
      Get boolean property QueryOnly (QUERY_ONLY_PTID).
      Returns:
      Value of property

    • setQueryOnly

      public void setQueryOnly(boolean value)
      Sets boolean property QueryOnly (QUERY_ONLY_PTID).
      Parameters:
      value - Value to set property to

    • isRendered

      public boolean isRendered()
      Get boolean property Rendered (RENDERED_PTID).
      Returns:
      Value of property

    • setRendered

      public void setRendered(boolean value)
      Sets boolean property Rendered (RENDERED_PTID).
      Parameters:
      value - Value to set property to

    • isRequired

      public boolean isRequired()
      Get boolean property Required (REQUIRED_PTID).
      Returns:
      Value of property

    • setRequired

      public void setRequired(boolean value)
      Sets boolean property Required (REQUIRED_PTID).
      Parameters:
      value - Value to set property to

    • isRolloverBorder

      public boolean isRolloverBorder()
      Get boolean property RolloverBorder (ROLLOVER_BORDER_PTID).
      Returns:
      Value of property

    • setRolloverBorder

      public void setRolloverBorder(boolean value)
      Sets boolean property RolloverBorder (ROLLOVER_BORDER_PTID).
      Parameters:
      value - Value to set property to

    • isRolloverSwap

      public boolean isRolloverSwap()
      Get boolean property RolloverSwap (ROLLOVER_SWAP_PTID).
      Returns:
      Value of property

    • setRolloverSwap

      public void setRolloverSwap(boolean value)
      Sets boolean property RolloverSwap (ROLLOVER_SWAP_PTID).
      Parameters:
      value - Value to set property to

    • isSecureToggle

      public boolean isSecureToggle()
      Get boolean property SecureToggle (SECURE_TOGGLE_PTID).
      Returns:
      Value of property

    • setSecureToggle

      public void setSecureToggle(boolean value)
      Sets boolean property SecureToggle (SECURE_TOGGLE_PTID).
      Parameters:
      value - Value to set property to

    • isShowFastForward

      public boolean isShowFastForward()
      Get boolean property ShowFastForward (SHOW_FAST_FORWARD_PTID).
      Returns:
      Value of property

    • setShowFastForward

      public void setShowFastForward(boolean value)
      Sets boolean property ShowFastForward (SHOW_FAST_FORWARD_PTID).
      Parameters:
      value - Value to set property to

    • isShowHorizontalScrollbar

      public boolean isShowHorizontalScrollbar()
      Get boolean property ShowHorizontalScrollbar (SHOW_HORIZONTAL_SCROLLBAR_PTID).
      Returns:
      Value of property

    • setShowHorizontalScrollbar

      public void setShowHorizontalScrollbar(boolean value)
      Sets boolean property ShowHorizontalScrollbar (SHOW_HORIZONTAL_SCROLLBAR_PTID).
      Parameters:
      value - Value to set property to

    • isShowPlay

      public boolean isShowPlay()
      Get boolean property ShowPlay (SHOW_PLAY_PTID).
      Returns:
      Value of property

    • setShowPlay

      public void setShowPlay(boolean value)
      Sets boolean property ShowPlay (SHOW_PLAY_PTID).
      Parameters:
      value - Value to set property to

    • isShowRecord

      public boolean isShowRecord()
      Get boolean property ShowRecord (SHOW_RECORD_PTID).
      Returns:
      Value of property

    • setShowRecord

      public void setShowRecord(boolean value)
      Sets boolean property ShowRecord (SHOW_RECORD_PTID).
      Parameters:
      value - Value to set property to

    • isShowRewind

      public boolean isShowRewind()
      Get boolean property ShowRewind (SHOW_REWIND_PTID).
      Returns:
      Value of property

    • setShowRewind

      public void setShowRewind(boolean value)
      Sets boolean property ShowRewind (SHOW_REWIND_PTID).
      Parameters:
      value - Value to set property to

    • isShowSlider

      public boolean isShowSlider()
      Get boolean property ShowSlider (SHOW_SLIDER_PTID).
      Returns:
      Value of property

    • setShowSlider

      public void setShowSlider(boolean value)
      Sets boolean property ShowSlider (SHOW_SLIDER_PTID).
      Parameters:
      value - Value to set property to

    • isShowTime

      public boolean isShowTime()
      Get boolean property ShowTime (SHOW_TIME_PTID).
      Returns:
      Value of property

    • setShowTime

      public void setShowTime(boolean value)
      Sets boolean property ShowTime (SHOW_TIME_PTID).
      Parameters:
      value - Value to set property to

    • isShowVerticalScrollbar

      public boolean isShowVerticalScrollbar()
      Get boolean property ShowVerticalScrollbar (SHOW_VERTICAL_SCROLLBAR_PTID).
      Returns:
      Value of property

    • setShowVerticalScrollbar

      public void setShowVerticalScrollbar(boolean value)
      Sets boolean property ShowVerticalScrollbar (SHOW_VERTICAL_SCROLLBAR_PTID).
      Parameters:
      value - Value to set property to

    • isShowVolume

      public boolean isShowVolume()
      Get boolean property ShowVolume (SHOW_VOLUME_PTID).
      Returns:
      Value of property

    • setShowVolume

      public void setShowVolume(boolean value)
      Sets boolean property ShowVolume (SHOW_VOLUME_PTID).
      Parameters:
      value - Value to set property to

    • isSubclassSubObject

      public boolean isSubclassSubObject()
      Get boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).
      Returns:
      Value of property

    • setSubclassSubObject

      public void setSubclassSubObject(boolean value)
      Sets boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).
      Parameters:
      value - Value to set property to

    • isTreeAllowEmpBranch

      public boolean isTreeAllowEmpBranch()
      Get boolean property TreeAllowEmpBranch (TREE_ALLOW_EMP_BRANCH_PTID).
      Returns:
      Value of property

    • setTreeAllowEmpBranch

      public void setTreeAllowEmpBranch(boolean value)
      Sets boolean property TreeAllowEmpBranch (TREE_ALLOW_EMP_BRANCH_PTID).
      Parameters:
      value - Value to set property to

    • isTreeMultiSelect

      public boolean isTreeMultiSelect()
      Get boolean property TreeMultiSelect (TREE_MULTI_SELECT_PTID).
      Returns:
      Value of property

    • setTreeMultiSelect

      public void setTreeMultiSelect(boolean value)
      Sets boolean property TreeMultiSelect (TREE_MULTI_SELECT_PTID).
      Parameters:
      value - Value to set property to

    • isTreeShowLines

      public boolean isTreeShowLines()
      Get boolean property TreeShowLines (TREE_SHOW_LINES_PTID).
      Returns:
      Value of property

    • setTreeShowLines

      public void setTreeShowLines(boolean value)
      Sets boolean property TreeShowLines (TREE_SHOW_LINES_PTID).
      Parameters:
      value - Value to set property to

    • isTreeShowSymbol

      public boolean isTreeShowSymbol()
      Get boolean property TreeShowSymbol (TREE_SHOW_SYMBOL_PTID).
      Returns:
      Value of property

    • setTreeShowSymbol

      public void setTreeShowSymbol(boolean value)
      Sets boolean property TreeShowSymbol (TREE_SHOW_SYMBOL_PTID).
      Parameters:
      value - Value to set property to

    • isUpdateAllowed

      public boolean isUpdateAllowed()
      Get boolean property UpdateAllowed (UPDATE_ALLOWED_PTID).
      Returns:
      Value of property

    • setUpdateAllowed

      public void setUpdateAllowed(boolean value)
      Sets boolean property UpdateAllowed (UPDATE_ALLOWED_PTID).
      Parameters:
      value - Value to set property to

    • isUpdateCommit

      public boolean isUpdateCommit()
      Get boolean property UpdateCommit (UPDATE_COMMIT_PTID).
      Returns:
      Value of property

    • setUpdateCommit

      public void setUpdateCommit(boolean value)
      Sets boolean property UpdateCommit (UPDATE_COMMIT_PTID).
      Parameters:
      value - Value to set property to

    • isUpdateIfNull

      public boolean isUpdateIfNull()
      Get boolean property UpdateIfNull (UPDATE_IF_NULL_PTID).
      Returns:
      Value of property

    • setUpdateIfNull

      public void setUpdateIfNull(boolean value)
      Sets boolean property UpdateIfNull (UPDATE_IF_NULL_PTID).
      Parameters:
      value - Value to set property to

    • isUpdateQuery

      public boolean isUpdateQuery()
      Get boolean property UpdateQuery (UPDATE_QUERY_PTID).
      Returns:
      Value of property

    • setUpdateQuery

      public void setUpdateQuery(boolean value)
      Sets boolean property UpdateQuery (UPDATE_QUERY_PTID).
      Parameters:
      value - Value to set property to

    • isValidateFromList

      public boolean isValidateFromList()
      Get boolean property ValidateFromList (VALIDATE_FROM_LIST_PTID).
      Returns:
      Value of property

    • setValidateFromList

      public void setValidateFromList(boolean value)
      Sets boolean property ValidateFromList (VALIDATE_FROM_LIST_PTID).
      Parameters:
      value - Value to set property to

    • isVisible

      public boolean isVisible()
      Get boolean property Visible (VISIBLE_PTID).
      Returns:
      Value of property

    • setVisible

      public void setVisible(boolean value)
      Sets boolean property Visible (VISIBLE_PTID).
      Parameters:
      value - Value to set property to

    • getCanvasObject

      public Canvas getCanvasObject()
      Get object property CanvasObject (CANVAS_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setCanvasObject

      public void setCanvasObject(Canvas value)
      Set object property CanvasObject (CANVAS_OBJECT_PTID).
      Parameters:
      value - Canvas object to set property to

    • getEditObject

      public Editor getEditObject()
      Get object property EditObject (EDIT_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setEditObject

      public void setEditObject(Editor value)
      Set object property EditObject (EDIT_OBJECT_PTID).
      Parameters:
      value - Editor object to set property to

    • getLovObject

      public LOV getLovObject()
      Get object property LovObject (LOV_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setLovObject

      public void setLovObject(LOV value)
      Set object property LovObject (LOV_OBJECT_PTID).
      Parameters:
      value - LOV object to set property to

    • getModule

      public JdapiObject getModule()
      Get object property Module (MODULE_PTID). The return value may be an instance of: MenuModule ObjectLibrary FormModule
      Specified by:
      getModule in interface JdapiObject
      Returns:
      Value of property downcast to a JdapiObject (null if none)

    • getNextNavigationItemObject

      public Item getNextNavigationItemObject()
      Get object property NextNavigationItemObject (NEXT_NAVIGATION_ITEM_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setNextNavigationItemObject

      public void setNextNavigationItemObject(Item value)
      Set object property NextNavigationItemObject (NEXT_NAVIGATION_ITEM_OBJECT_PTID).
      Parameters:
      value - Item object to set property to

    • getOwner

      public JdapiObject getOwner()
      Get object property Owner (OWNER_PTID). The return value may be an instance of: ObjectGroup Block ObjectLibraryTab
      Specified by:
      getOwner in interface JdapiObject
      Returns:
      Value of property downcast to a JdapiObject (null if none)

    • getPopupMenuObject

      public Menu getPopupMenuObject()
      Get object property PopupMenuObject (POPUP_MENU_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setPopupMenuObject

      public void setPopupMenuObject(Menu value)
      Set object property PopupMenuObject (POPUP_MENU_OBJECT_PTID).
      Parameters:
      value - Menu object to set property to

    • getPopupVisualAttributeObject

      public VisualAttribute getPopupVisualAttributeObject()
      Get object property PopupVisualAttributeObject (POPUP_VISUALATTRIBUTE_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setPopupVisualAttributeObject

      public void setPopupVisualAttributeObject(VisualAttribute value)
      Set object property PopupVisualAttributeObject (POPUP_VISUALATTRIBUTE_OBJECT_PTID).
      Parameters:
      value - VisualAttribute object to set property to

    • getPreviousNavigationItemObject

      public Item getPreviousNavigationItemObject()
      Get object property PreviousNavigationItemObject (PREVIOUS_NAVIGATION_ITEM_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setPreviousNavigationItemObject

      public void setPreviousNavigationItemObject(Item value)
      Set object property PreviousNavigationItemObject (PREVIOUS_NAVIGATION_ITEM_OBJECT_PTID).
      Parameters:
      value - Item object to set property to

    • getPromptVisualAttributeObject

      public VisualAttribute getPromptVisualAttributeObject()
      Get object property PromptVisualAttributeObject (PROMPT_VISUALATTRIBUTE_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setPromptVisualAttributeObject

      public void setPromptVisualAttributeObject(VisualAttribute value)
      Set object property PromptVisualAttributeObject (PROMPT_VISUALATTRIBUTE_OBJECT_PTID).
      Parameters:
      value - VisualAttribute object to set property to

    • getRadioButtons

      public JdapiIterator getRadioButtons()
      Accessor for child RadioButton objects (RADIO_BUTTON_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
      Returns:
      Iterator of RadioButton objects

    • getRecordGroupObject

      public RecordGroup getRecordGroupObject()
      Get object property RecordGroupObject (RECORD_GROUP_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setRecordGroupObject

      public void setRecordGroupObject(RecordGroup value)
      Set object property RecordGroupObject (RECORD_GROUP_OBJECT_PTID).
      Parameters:
      value - RecordGroup object to set property to

    • getRecordVisualAttributeGroupObject

      public VisualAttribute getRecordVisualAttributeGroupObject()
      Get object property RecordVisualAttributeGroupObject (RECORD_VISUALATTRIBUTE_GROUP_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setRecordVisualAttributeGroupObject

      public void setRecordVisualAttributeGroupObject(VisualAttribute value)
      Set object property RecordVisualAttributeGroupObject (RECORD_VISUALATTRIBUTE_GROUP_OBJECT_PTID).
      Parameters:
      value - VisualAttribute object to set property to

    • getSource

      public JdapiObject getSource()
      Get object property Source (SOURCE_PTID). The return value may be an instance of: Item PropertyClass
      Returns:
      Value of property downcast to a JdapiObject (null if none)

    • getSynchronizedItemObject

      public Item getSynchronizedItemObject()
      Get object property SynchronizedItemObject (SYNCHRONIZED_ITEM_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setSynchronizedItemObject

      public void setSynchronizedItemObject(Item value)
      Set object property SynchronizedItemObject (SYNCHRONIZED_ITEM_OBJECT_PTID).
      Parameters:
      value - Item object to set property to

    • getTabPageObject

      public TabPage getTabPageObject()
      Get object property TabPageObject (TABPAGE_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setTabPageObject

      public void setTabPageObject(TabPage value)
      Set object property TabPageObject (TABPAGE_OBJECT_PTID).
      Parameters:
      value - TabPage object to set property to

    • getTriggers

      public JdapiIterator getTriggers()
      Accessor for child Trigger objects (TRIGGER_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
      Returns:
      Iterator of Trigger objects

    • getVisualAttributeObject

      public VisualAttribute getVisualAttributeObject()
      Get object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).
      Returns:
      Value of property (null if none)

    • setVisualAttributeObject

      public void setVisualAttributeObject(VisualAttribute value)
      Set object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).
      Parameters:
      value - VisualAttribute object to set property to

    • getObjectPointer

      protected long getObjectPointer()
      Gets the Forms API pointer for this object.
      Returns:
      C pointer to the Forms object

    • queryType

      public int queryType()
      Returns the FormAPI object type ID (x_OTID in JdapiTypes). This should always be the same value as returned for getTypeId. The difference between the two methods is that queryType calls down to the API itself; this ensures that the correct type is returned. Because this method calls down to the API, you might find it a little faster to use getTypeID instead.
      Specified by:
      queryType in interface JdapiObject
      Returns:
      x_OTID an object type ID as defined in JdapiTypes.

    • setClientInfo

      public void setClientInfo(Object clientInfo)
      Sets the client information. Since the clientInfo is a java.lang.Object, the client information can be anything you want to associate with the referred object. For example, you can create your own class, then pass it to this method. The referred object will retain a reference to the clientInfo.

      This client info object is not persistent and will be lost when the session ends.

      Specified by:
      setClientInfo in interface JdapiObject
      Parameters:
      clientInfo - client info to be associated with the object.

    • getClientInfo

      public Object getClientInfo()
      Returns the client info object associated with this Object. The type ID of the object returned is dependant on the type ID of the object that was set using setClientObject.
      Specified by:
      getClientInfo in interface JdapiObject
      Returns:
      the client info object associated with this object.

    • getPersistentClientInfoBlob

      public Blob getPersistentClientInfoBlob()
      Returns the persistent client info Blob associated with this object.
      Specified by:
      getPersistentClientInfoBlob in interface JdapiObject
      Returns:
      Blob containing client info.

    • getPersistentClientInfoObject

      public Object getPersistentClientInfoObject()
      Returns the persistent client info Java object associated with this object.
      Specified by:
      getPersistentClientInfoObject in interface JdapiObject
      Returns:
      java.lang.Object serialized into the Forms object.

    • setPersistentClientInfo

      public void setPersistentClientInfo(Blob val)
      Sets persistent client info for this object.

      Like the non-persistent client info methods, the client info can be any information that you want to save with the form. Unlike the non-persistent client info methods, the persistent info is saved as part of the form and will not be lost when the session is ended.

      Specified by:
      setPersistentClientInfo in interface JdapiObject
      Parameters:
      val - a Blob object containing client info.

    • setPersistentClientInfo

      public void setPersistentClientInfo(Serializable obj)
      Serializes any Java object which supports the Serializable interface to this object's Persistent Client Info.

      Like the non-persistent client info methods, the client info can be any information that you want to save with the form. Unlike the non-persistent client info methods, the persistent info is saved as part of the form and will not be lost when the session is ended.

      Specified by:
      setPersistentClientInfo in interface JdapiObject
      Parameters:
      obj - any Serializable object containing client info.

    • equals

      public boolean equals(JdapiObject obj)
      Compares two objects and determines if they are equal.
      Specified by:
      equals in interface JdapiObject
      Parameters:
      obj - object to be compared.
      Returns:
      true if the two objects are equal; returns false if they are not equal.

    • clone

      public JdapiObject clone(JdapiObject parent, String newName)
      Creates a clone of the specified object, creating a new object with the given name and owner. For example, given a Block in Form A, you can clone it into Form B by passing Form B in the parent parameter, and specifying a new name for the block in the newName parameter.

      The new object is the same as the original object in that it has the same property values. However, subclassing information is discarded, and the inherited property values "flattened" into local values in the new object.

      It is your reponsibility to pass in an appropriate parent object. If you do not do this, you will probably get a JdapiException runtime exception. If possible, use the type safe clone method that is provided on each Forms object class.

      Specified by:
      clone in interface JdapiObject
      Parameters:
      parent - owner of the new object.
      newName - name of the new object.
      Returns:
      the clone of the object.

    • changeOwner

      public void changeOwner(JdapiObject newOwner)
      Assigns a new owner to the referred object. This method will cause any previous owner to relinquish its ownership of the referred object.

      Set newOwner to null if you want the object to have no owner.

      The only restriction on this method is that the new owner must be in the same module as the referred object. If you attempt to assign a new owner that is in a different module, then a JdapiException will be thrown.

      Note: If you want to assign the object to a new owner in a different module, then you will have to clone or subclass the object.

      Specified by:
      changeOwner in interface JdapiObject
      Parameters:
      newOwner - the new owner of referred object; specify null if you want the object to have no owner.
      Throws:
      JdapiException - if newOwner is in a different module.

    • toString

      public String toString()
      Converts and returns the object properties to string format. This is useful for debugging purposes. The string is in the format: NAME(CLASSNAME, pointer: D2FOB*, context D2FCTX*)
      Specified by:
      toString in interface JdapiObject
      Overrides:
      toString in class Object
      Returns:
      String representation of the object

    • clearObjectPointer

      protected void clearObjectPointer()
      Used internally to flag this object as an invalid object.

    • isValidFormsObject

      public boolean isValidFormsObject()
      Description copied from interface: JdapiObject
      Determines whether this Java instance references a valid Forms object.

      For example, assume that you have a reference to a block. If you call destroy() on its owning module, then the module and all of its blocks should be deleted from memory. The reference that you have no longer refers to a valid Forms object. A call to isValidFormsObject() on the block should return false.

      Specified by:
      isValidFormsObject in interface JdapiObject
      Returns:
      true if the instance references a valid forms object; false otherwise.

    • destroy

      public void destroy()
      Destroys the object - this removes the object from it's context. The JNI level is responsible for removing this object from the context cache, so we don't need to do that in here.
      Specified by:
      destroy in interface JdapiObject

    • move

      public void move(JdapiObject next)
      Reorders an object with respect to its siblings in the collection it belongs to. This is similar to using drag and drop in Form Builder to move a block in a list. This method represents a way to do the same thing programmatically. For example, if you want a block appear immediately before Block5 in a list, you pass the object representing Block5 as the nextObject argument.

      Pass null to this method to move the object to the end of the list. If the specified object and the next_object do not share the same owner, or do not have the same type, the method throws an exception.

      You cannot use this method to move objects between parents. For example, it cannot be used to move an Item from one Block to another. If you want to move an object from one parent to another you will have to do something like: 

         // e.g. to move 'itmA' to be positioned before 'itmB' in block
   // 'blkB' (when 'itmA' is in another block)

   // copy itmA into a new parent (blkB) using same name
   Item newItmA = itmA.clone(blkB, itmA.getName());
   newItmA.move(itmB);   // move new item relative to itmB
   itmA.destroy();       // delete original object
   itmA = newItmA;
      Specified by:
      move in interface JdapiObject
      Parameters:
      next - the object next to which the specified object is to be moved.
      Throws:
      JdapiException - if you attempt to move an object next to an object that does not share the same owner or is not of the samme type.

    • getBooleanProperty

      public boolean getBooleanProperty(int propertyTypeId)
      Retrieves a boolean property from the referred object.
      Specified by:
      getBooleanProperty in interface JdapiObject
      Parameters:
      propertyTypeId - property type ID for which a boolean value is returned.
      Returns:
      the boolean property value.

    • getStringProperty

      public String getStringProperty(int propertyTypeId)
      Retrieves a string property from the referred object.
      Specified by:
      getStringProperty in interface JdapiObject
      Parameters:
      propertyTypeId - property type ID for which a string value is returned.
      Returns:
      the string property value.

    • getIntegerProperty

      public int getIntegerProperty(int propertyTypeId)
      Retrieves an integer property from the referred object. For example: 
         ...
    if(propClass.hasProperty(propNumber) && propClass.allowGet(propNumber))
    {
      int propValue = propClass.getIntegerProperty(propNum);
    } 
    ...
      Specified by:
      getIntegerProperty in interface JdapiObject
      Parameters:
      propertyTypeId - property type ID for which an integer value is returned.
      Returns:
      the integer property value.

    • getStringIDProperty

      public int getStringIDProperty(int propertyTypeId)
      Retrieves a special String ID (integer) property from the referred object.

      This method is intended for use with the TranslationTable object only. For a given property ID it retrieves the integer that indexes the string property in the table for the current language.

      Specified by:
      getStringIDProperty in interface JdapiObject
      Parameters:
      propertyTypeId - property type ID for which a String ID value is returned.
      Returns:
      the integer String ID property value.

    • getPropertyValueName

      public String getPropertyValueName(int propertyTypeId, int val)
      Description copied from interface: JdapiObject
      Gets the string representation of a given property's value.
      Specified by:
      getPropertyValueName in interface JdapiObject
      Parameters:
      propertyTypeId - Property number
      val - Value of property
      Returns:
      String representation

    • getIntegerPropertyString

      public String getIntegerPropertyString(int propertyTypeId)
      Description copied from interface: JdapiObject
      Gets a numeric (long) property value's text representation.
      Specified by:
      getIntegerPropertyString in interface JdapiObject
      Parameters:
      propertyTypeId - Number identifying the property
      Returns:
      Property's text representation

    • getObjProp

      protected long getObjProp(int propertyTypeId)
      Internal method used to get an object property value. This only really gets the C pointer to the Forms object. You must then use the ContextCache to lookup/instantiate the Java representation of the object.
      Parameters:
      propertyTypeId - Number identifying the property
      Returns:
      Property's value
      See Also:

    • getObjectProperty

      public JdapiObject getObjectProperty(int propertyTypeId)
      Description copied from interface: JdapiObject
      Retrieves a JdapiObject property from the referred object. For example, if you pass the integer propertyTypeId for an Item in a Block to this method, it returns the Item.
      Specified by:
      getObjectProperty in interface JdapiObject
      Parameters:
      propertyTypeId - property type ID for which a JdapiObject value is returned.
      Returns:
      the JdapiObject property value.

    • getChildObjectProperty

      public JdapiIterator getChildObjectProperty(int propertyTypeId)
      Description copied from interface: JdapiObject
      Retrieves child objects for a given property value. Implicit in this method is the idea of an ownership relationship between objects. Items are clearly owned by a Block. If you delete the Block, then its Items are deleted. On the other hand, Items can appear on a Canvas. If you delete the Canvas, however, the Items are not deleted. Thus, the method returns an iterator over Items if it is passed a Block. In contrast, if it is passed a Canvas, it should not return an iterator over Items.

      For example: 

            ...
      // get the actual values for the current child object type, 
      // for example, get the Items on a Block 
      iter = jo.getChildObjectProperty(prop.getPropertyId());  
      ...
      Note, it should be (slightly) faster to call the specific method on the object, for example getBlocks() on the FormModule, as it involves fewer API calls. However, getChildObjectProperty should be sufficient if you only have a propertyTypeId available.

      This method also differs from the direct accessors in that null is returned if there are no objects, not an empty iterator.

      Specified by:
      getChildObjectProperty in interface JdapiObject
      Parameters:
      propertyTypeId - number identifying the child object property.
      Returns:
      Iterator for child objects, can return null if there are no child objects.

    • setBooleanProperty

      public void setBooleanProperty(int propertyTypeId, boolean propertyValue)
      Description copied from interface: JdapiObject
      Sets the value of the specified boolean property belonging to the referred object.
      Specified by:
      setBooleanProperty in interface JdapiObject
      Parameters:
      propertyTypeId - property type ID of the property for which you want to set the boolean value.
      propertyValue - the boolean value for the property.

    • setStringProperty

      public void setStringProperty(int propertyTypeId, String propertyValue)
      Description copied from interface: JdapiObject
      Sets the value of the specified string property for the object.
      Specified by:
      setStringProperty in interface JdapiObject
      Parameters:
      propertyTypeId - property type ID of the property for which you want to set the string value.
      propertyValue - the string value for the property.

    • setIntegerProperty

      public void setIntegerProperty(int propertyTypeId, int propertyValue)
      Sets the value of the specified object integer property.
      Specified by:
      setIntegerProperty in interface JdapiObject
      Parameters:
      propertyTypeId - property type id for which we set the integer value.
      propertyValue - the integer property value in property.

    • setObjProp

      protected void setObjProp(int propertyTypeId, long val)
      Internal method used to set an object property. This sets the object property by the C pointer to the object you want to set.
      Parameters:
      propertyTypeId - Number identifying the property
      val - Value to set the property to
      See Also:

    • setObjectProperty

      public void setObjectProperty(int propertyTypeId, JdapiObject propertyValue)
      Sets the value of the specified object object property value.
      Specified by:
      setObjectProperty in interface JdapiObject
      Parameters:
      propertyTypeId - property type id for which we set the object property value.
      propertyValue - the object property value in property.

    • hasProperty

      public boolean hasProperty(int propertyTypeId)
      Checks if the object has a given property.
      Specified by:
      hasProperty in interface JdapiObject
      Parameters:
      propertyTypeId - Number identifying the property
      Returns:
      'true' if the object has that property, 'false' otherwise

    • inheritProperty

      public void inheritProperty(int propertyTypeId)
      Resets a property to it's default value (confusing name eh?). What it's really doing is setting the property to it's base classes value - i.e. whatever it's subclassed from. If the object is not subclassed from anything, then this is the default value.
      Specified by:
      inheritProperty in interface JdapiObject
      Parameters:
      propertyTypeId - Number that identified the property

    • hasInheritedProperty

      public boolean hasInheritedProperty(int propertyTypeId)
      Checks if a property is inherited.
      Specified by:
      hasInheritedProperty in interface JdapiObject
      Parameters:
      propertyTypeId - Number that identified the property
      Returns:
      'true' if property is inherited

    • hasOverriddenProperty

      public boolean hasOverriddenProperty(int propertyTypeId)
      Determine whether the object referred has a property of the given type id with an overridden value.
      Specified by:
      hasOverriddenProperty in interface JdapiObject
      Parameters:
      propertyTypeId - The type id of the property to be queried.
      Returns:
      TRUE if the object's property has overridden value, else FALSE.

    • hasDefaultedProperty

      public boolean hasDefaultedProperty(int propertyTypeId)
      Checks if a property is set to it's default value.
      Specified by:
      hasDefaultedProperty in interface JdapiObject
      Parameters:
      propertyTypeId - Number that identified the property
      Returns:
      'true' if the property is set to the default value

    • getPropertyState

      public int getPropertyState(int propertyTypeId)
      Returns the current state of the specified property.

      A property can be in one of the 5 states:
      PROPERTY_STATE_UNKNOWN = 0;
      PROPERTY_DEFAULT_VALUE = 1;
      PROPERTY_OVERRIDDEN_DEFAULT_VALUE = 2;
      PROPERTY_INHERITED_VALUE = 3;
      PROPERTY_OVERRIDDEN_INHERITED_VALUE = 3;

      Specified by:
      getPropertyState in interface JdapiObject
      Parameters:
      propertyTypeId - The type id of the property.
      Returns:
      integer 0 through 3 representing one of the states.

    • isSubclassed

      public boolean isSubclassed()
      Checks if the object is subclassed from another object.
      Specified by:
      isSubclassed in interface JdapiObject
      Returns:
      'true' if the object is subclassed, 'false' otherwise

    • getSubclassParent

      public JdapiObject getSubclassParent()
      Get Source (SOURCE_PTID) object property, i.e. the object this object subclassed from. This is also implemented on derived classed with this property as getSource().
      Specified by:
      getSubclassParent in interface JdapiObject
      Returns:
      Value of property downcast to a BaseFormsObject (null if none of object does not have this property)

    • setSubclassParent

      public void setSubclassParent(JdapiObject parent)
      Change the subclassing parent of the object referred.

      The metadata associated with each object describes the types of objects that can become its subclassing parent. If the subclassing metadata associated with the refrred object doesn't indicate the objects of the given parent's type are allowed, then this method will throw an exception.

      Specified by:
      setSubclassParent in interface JdapiObject
      Parameters:
      parent - The parent object. If this is null, the child the referred object will become an orphan. This is the way to unset the subclassing parent of an object.

    • unsetSubclassParent

      public void unsetSubclassParent()
      Remove the subclassing parent of the object referred.

      The subclassing will be removed completely if it existed and the object will now contain the default values.

    • createSubclassedChild

      public JdapiObject createSubclassedChild(JdapiObject childOwner, String childName)
      Subclass the referred object. The child will be owned by the referred object specified.
      Specified by:
      createSubclassedChild in interface JdapiObject
      Parameters:
      childOwner - The object that will own the newly created subclassed child object.
      childName - The name to be given to the newly created child.
      Returns:
      the subclassed object.

    • reattach

      public void reattach()
      Reattaches subclassed object. You must call this method if you manipulate any of the following properties of a Forms object: PAR_MODULE_PTID, PAR_NAM_PTID, PAR_SL1OBJ_NAM_PTID, PAR_MODTYP_PTID, PAR_TYP_PTID, PARSL1OBJ_TYP_PTID This is only if you are manipulating these low level subclassing properties.
      Specified by:
      reattach in interface JdapiObject

    • getOwnedObjects

      public JdapiIterator getOwnedObjects()
      Get the object instances owned by this particular object.
      Specified by:
      getOwnedObjects in interface JdapiObject
      Returns:
      Iterator of JdapiObjects

    • getClassName

      public String getClassName()
      Gets the class name of the object. This is useful if you want to refer to the name of the Forms object in some output but don't want the Java package details.
      Specified by:
      getClassName in interface JdapiObject
      Returns:
      Name of "class" of Forms object

    • getQualifiedName

      public String getQualifiedName(boolean includeModule)
      Gets a fully qualified name for the object in the format of: MODULE.OBJECT.CHILD.CHILD... i.e. '.' separates the objects names from the current object back upto the module.

      Specified by:
      getQualifiedName in interface JdapiObject
      Parameters:
      includeModule - Include the module name

    • getJdapiMetaObject

      public JdapiMetaObject getJdapiMetaObject()
      Gets the metadata object for the specified object.
      Specified by:
      getJdapiMetaObject in interface JdapiObject
      Returns:
      the metadata object for the specified object.

    • getMetaProperties

      public JdapiIterator getMetaProperties()
      Return an iterator over the meta properties in object referred.

      The various property type ids and the object-property mapping are defined by the specific implementation in the respective Constants file.

      Specified by:
      getMetaProperties in interface JdapiObject
      Returns:
      an enumeration of the specified object meta properties.