oracle.forms.jdapi
Class Item

java.lang.Object
  |
  +--oracle.forms.jdapi.BaseFormsObject
        |
        +--oracle.forms.jdapi.Item
All Implemented Interfaces:
JdapiObject

public class Item
extends oracle.forms.jdapi.BaseFormsObject

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 Summary
protected  java.lang.Object m_clientInfo
          Client info object held against this Forms object.
protected  long m_pd2fob
          This is the d2fob pointer in the C ifjapi60 for the object that is derived from this class.
 
Fields inherited from interface oracle.forms.jdapi.JdapiObject
PROPERTY_DEFAULT_VALUE, PROPERTY_INHERITED_VALUE, PROPERTY_OVERRIDDEN_DEFAULT_VALUE, PROPERTY_OVERRIDDEN_INHERITED_VALUE, PROPERTY_STATE_UNKNOWN
 
Constructor Summary
  Item(Block parent, java.lang.String name)
          Constructor used to create Item objects in the context of a Block parent object.
  Item(Block parent, java.lang.String name, Item base)
          Constructor used to create Item objects in the context of a Block parent object.
  Item(Block parent, java.lang.String name, PropertyClass base)
          Constructor used to create Item objects in the context of a Block parent object.
protected Item(long pd2fitm)
          Protected constructor, used internally to create Item objects.
  Item(ObjectGroup parent, java.lang.String name)
          Constructor used to create Item objects in the context of a ObjectGroup parent object.
  Item(ObjectGroup parent, java.lang.String name, Item base)
          Constructor used to create Item objects in the context of a ObjectGroup parent object.
  Item(ObjectGroup parent, java.lang.String name, PropertyClass base)
          Constructor used to create Item objects in the context of a ObjectGroup parent object.
  Item(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name)
          Constructor used to create Item objects in the context of an ObjectLibraryTab parent object.
  Item(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, Item base)
          Constructor used to create Item objects in the context of an ObjectLibraryTab parent object.
  Item(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, PropertyClass base)
          Constructor used to create Item objects in the context of an ObjectLibraryTab parent object.
 
Method Summary
 void changeOwner(JdapiObject newOwner)
          Assigns a new owner to the referred object.
protected  void clearObjectPointer()
          Used internally to flag this object as an invalid object.
 Item clone(Block parent, java.lang.String newName)
          Creates a copy of the object as a child of 'parent'
 JdapiObject clone(JdapiObject parent, java.lang.String newName)
          Creates a clone of the specified object, creating a new object with the given name and owner.
 Item clone(ObjectGroup parent, java.lang.String newName)
          Creates a copy of the object as a child of 'parent'
 Item clone(ObjectLibraryTab parent, java.lang.String newName)
          Creates a copy of the object as a child of 'parent'
 JdapiObject createSubclassedChild(JdapiObject childOwner, java.lang.String childName)
          Subclass the referred object.
 void deleteElement(int index)
          Deletes a row from the list elements of a list item.
 void destroy()
          Destroys the object - this removes the object from it's context.
 boolean equals(JdapiObject obj)
          Compares two objects and determines if they are equal.
static Item find(Block parent, java.lang.String name)
          Find an instance of Item that is a child of a Block.
static Item find(ObjectGroup parent, java.lang.String name)
          Find an instance of Item that is a child of a ObjectGroup.
static Item find(ObjectLibraryTab parent, java.lang.String name)
          Find an instance of Item that is a child of a ObjectLibraryTab.
 java.lang.String getAccessKey()
          Get text property AccessKey (ACCESS_KEY_PTID).
 int getAudioChannels()
          Get number property AudioChannels (AUDIO_CHANNELS_PTID).
 java.lang.String getBackColor()
          Get text property BackColor (BACK_COLOR_PTID).
 int getBevel()
          Get number property Bevel (BEVEL_PTID).
 boolean getBooleanProperty(int propertyTypeId)
          Retrieves a boolean property from the referred object.
 int getCalculateMode()
          Get number property CalculateMode (CALCULATE_MODE_PTID).
 java.lang.String getCanvasName()
          Get text property CanvasName (CANVAS_NAME_PTID).
 Canvas getCanvasObject()
          Get object property CanvasObject (CANVAS_OBJECT_PTID).
 int getCaseRestriction()
          Get number property CaseRestriction (CASE_RESTRICTION_PTID).
 int getCheckBoxOtherValues()
          Get number property CheckBoxOtherValues (CHECK_BOX_OTHER_VALUES_PTID).
 java.lang.String getCheckedValue()
          Get text property CheckedValue (CHECKED_VALUE_PTID).
 JdapiIterator getChildObjectProperty(int propertyTypeId)
          Retrieves child objects for a given property value.
 java.lang.String getClassName()
          Gets the class name of the object.
 java.lang.Object getClientInfo()
          Returns the client info object associated with this Object.
 java.lang.String getColumnName()
          Get text property ColumnName (COLUMN_NAME_PTID).
 java.lang.String getComment()
          Get text property Comment (COMMENT_PTID).
 int getCommMode()
          Get number property CommMode (COMM_MODE_PTID).
 int getCompress()
          Get number property Compress (COMPRESS_PTID).
 int getCompressionQuality()
          Get number property CompressionQuality (COMPRESSION_QUALITY_PTID).
 java.lang.String getCopyValueFromItem()
          Get text property CopyValueFromItem (COPY_VALUE_FROM_ITEM_PTID).
 int getDataLengthSemantics()
          Get number property DataLengthSemantics (DATA_LENGTH_SEMANTICS_PTID).
 java.lang.String getDataSourceBlock()
          Get text property DataSourceBlock (DATA_SOURCE_BLOCK_PTID).
 java.lang.String getDataSourceXAxis()
          Get text property DataSourceXAxis (DATA_SOURCE_X_AXIS_PTID).
 java.lang.String getDataSourceYAxis()
          Get text property DataSourceYAxis (DATA_SOURCE_Y_AXIS_PTID).
 int getDataType()
          Get number property DataType (DATA_TYPE_PTID).
 int getDisplayQuality()
          Get number property DisplayQuality (DISPLAY_QUALITY_PTID).
 int getDistanceBetweenRecords()
          Get number property DistanceBetweenRecords (DISTANCE_BETWEEN_RECORDS_PTID).
 java.lang.String getEditName()
          Get text property EditName (EDIT_NAME_PTID).
 Editor getEditObject()
          Get object property EditObject (EDIT_OBJECT_PTID).
 int getEditXPosition()
          Get number property EditXPosition (EDIT_X_POSITION_PTID).
 int getEditYPosition()
          Get number property EditYPosition (EDIT_Y_POSITION_PTID).
 java.lang.String getElementLabel(int index)
          Retrieves the label of a list element row of a list item.
 java.lang.String getElementValue(int index)
          Retrieves the value of a list element row of a list item.
 int getExecuteMode()
          Get number property ExecuteMode (EXECUTE_MODE_PTID).
 java.lang.String getFilename()
          Get text property Filename (FILENAME_PTID).
 java.lang.String getFillPattern()
          Get text property FillPattern (FILL_PATTERN_PTID).
 java.lang.String getFontName()
          Get text property FontName (FONT_NAME_PTID).
 int getFontSize()
          Get number property FontSize (FONT_SIZE_PTID).
 int getFontSpacing()
          Get number property FontSpacing (FONT_SPACING_PTID).
 int getFontStyle()
          Get number property FontStyle (FONT_STYLE_PTID).
 int getFontWeight()
          Get number property FontWeight (FONT_WEIGHT_PTID).
 java.lang.String getForegroundColor()
          Get text property ForegroundColor (FOREGROUND_COLOR_PTID).
 java.lang.String getFormatMask()
          Get text property FormatMask (FORMAT_MASK_PTID).
 java.lang.String getFormula()
          Get text property Formula (FORMULA_PTID).
 int getHeight()
          Get number property Height (HEIGHT_PTID).
 java.lang.String getHelpBookTopic()
          Get text property HelpBookTopic (HELP_BOOK_TOPIC_PTID).
 java.lang.String getHighestAllowedValue()
          Get text property HighestAllowedValue (HIGHEST_ALLOWED_VALUE_PTID).
 java.lang.String getHint()
          Get text property Hint (HINT_PTID).
 java.lang.String getIconFilename()
          Get text property IconFilename (ICON_FILENAME_PTID).
 int getImageDepth()
          Get number property ImageDepth (IMAGE_DEPTH_PTID).
 int getImageFormat()
          Get number property ImageFormat (IMAGE_FORMAT_PTID).
 java.lang.String getImplementationClass()
          Get text property ImplementationClass (IMPLEMENTATION_CLASS_PTID).
 int getInitializeKeyboardDirection()
          Get number property InitializeKeyboardDirection (INITIALIZE_KEYBOARD_DIRECTION_PTID).
 java.lang.String getInitializeValue()
          Get text property InitializeValue (INITIALIZE_VALUE_PTID).
 int getIntegerProperty(int propertyTypeId)
          Retrieves an integer property from the referred object.
 java.lang.String getIntegerPropertyString(int propertyTypeId)
          Gets a numeric (long) property value's text representation.
 int getItemsDisplay()
          Get number property ItemsDisplay (ITEMS_DISPLAY_PTID).
 int getItemType()
          Get number property ItemType (ITEM_TYPE_PTID).
 JdapiMetaObject getJdapiMetaObject()
          Gets the metadata object for the specified object.
 int getJustification()
          Get number property Justification (JUSTIFICATION_PTID).
 int getKeyboardState()
          Get number property KeyboardState (KEYBOARD_STATE_PTID).
 java.lang.String getLabel()
          Get text property Label (LABEL_PTID).
 int getLanguageDirection()
          Get number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
 int getListElementCount()
          Get number property ListElementCount (LIST_ELEMENT_COUNT_PTID).
 int getListStyle()
          Get number property ListStyle (LIST_STYLE_PTID).
 java.lang.String getLovName()
          Get text property LovName (LOV_NAME_PTID).
 LOV getLovObject()
          Get object property LovObject (LOV_OBJECT_PTID).
 int getLovXPosition()
          Get number property LovXPosition (LOV_X_POSITION_PTID).
 int getLovYPosition()
          Get number property LovYPosition (LOV_Y_POSITION_PTID).
 java.lang.String getLowestAllowedValue()
          Get text property LowestAllowedValue (LOWEST_ALLOWED_VALUE_PTID).
 int getMaximumLength()
          Get number property MaximumLength (MAXIMUM_LENGTH_PTID).
 JdapiIterator getMetaProperties()
          Return an iterator over the meta properties in object referred.
 JdapiObject getModule()
          Get object property Module (MODULE_PTID).
 java.lang.String getName()
          Get text property Name (NAME_PTID).
 java.lang.String getNextNavigationItemName()
          Get text property NextNavigationItemName (NEXT_NAVIGATION_ITEM_NAME_PTID).
 Item getNextNavigationItemObject()
          Get object property NextNavigationItemObject (NEXT_NAVIGATION_ITEM_OBJECT_PTID).
protected  long getObjectPointer()
          Gets the Forms API pointer for this object.
 JdapiObject getObjectProperty(int propertyTypeId)
          Retrieves a JdapiObject property from the referred object.
protected  long getObjProp(int propertyTypeId)
          Internal method used to get an object property value.
 int getOleActionStyle()
          Get number property OleActionStyle (OLE_ACTION_STYLE_PTID).
 java.lang.String getOleClass()
          Get text property OleClass (OLE_CLASS_PTID).
 int getOlePopupMenuItems()
          Get number property OlePopupMenuItems (OLE_POPUP_MENU_ITEMS_PTID).
 int getOleResizStyle()
          Get number property OleResizStyle (OLE_RESIZ_STYLE_PTID).
 int getOleTenantTypeAspect()
          Get number property OleTenantTypeAspect (OLE_TENANTTYPE_ASPECT_PTID).
 int getOleTenantTypeType()
          Get number property OleTenantTypeType (OLE_TENANTTYPE_TYPE_PTID).
 java.lang.String getOtherValues()
          Get text property OtherValues (OTHER_VALUES_PTID).
 JdapiIterator getOwnedObjects()
          Get the object instances owned by this particular object.
 JdapiObject getOwner()
          Get object property Owner (OWNER_PTID).
 java.lang.String getParentFilename()
          Get text property ParentFilename (PARENT_FILENAME_PTID).
 java.lang.String getParentFilepath()
          Get text property ParentFilepath (PARENT_FILEPATH_PTID).
 java.lang.String getParentModule()
          Get text property ParentModule (PARENT_MODULE_PTID).
 int getParentModuleType()
          Get number property ParentModuleType (PARENT_MODULETYPE_PTID).
 java.lang.String getParentName()
          Get text property ParentName (PARENT_NAME_PTID).
 java.lang.String getParentSourceLevel1ObjectName()
          Get text property ParentSourceLevel1ObjectName (PARENT_SOURCELEVEL1OBJECT_NAME_PTID).
 int getParentSourceLevel1ObjectType()
          Get number property ParentSourceLevel1ObjectType (PARENT_SOURCELEVEL1OBJECT_TYPE_PTID).
 int getParentType()
          Get number property ParentType (PARENT_TYPE_PTID).
 Blob getPersistentClientInfoBlob()
          Returns the persistent client info Blob associated with this object.
 int getPersistentClientInfoLength()
          Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
 java.lang.Object getPersistentClientInfoObject()
          Returns the persistent client info Java object associated with this object.
 java.lang.String getPopupMenuName()
          Get text property PopupMenuName (POPUP_MENU_NAME_PTID).
 Menu getPopupMenuObject()
          Get object property PopupMenuObject (POPUP_MENU_OBJECT_PTID).
 VisualAttribute getPopupVisualAttributeObject()
          Get object property PopupVisualAttributeObject (POPUP_VISUALATTRIBUTE_OBJECT_PTID).
 java.lang.String getPreviousNavigationItemName()
          Get text property PreviousNavigationItemName (PREVIOUS_NAVIGATION_ITEM_NAME_PTID).
 Item getPreviousNavigationItemObject()
          Get object property PreviousNavigationItemObject (PREVIOUS_NAVIGATION_ITEM_OBJECT_PTID).
 java.lang.String getPrompt()
          Get text property Prompt (PROMPT_PTID).
 int getPromptAlign()
          Get number property PromptAlign (PROMPT_ALIGN_PTID).
 int getPromptAlignOffset()
          Get number property PromptAlignOffset (PROMPT_ALIGN_OFFSET_PTID).
 int getPromptAttachmentEdge()
          Get number property PromptAttachmentEdge (PROMPT_ATTACHMENT_EDGE_PTID).
 int getPromptAttachmentOffset()
          Get number property PromptAttachmentOffset (PROMPT_ATTACHMENT_OFFSET_PTID).
 java.lang.String getPromptBackColor()
          Get text property PromptBackColor (PROMPT_BACK_COLOR_PTID).
 int getPromptDisplayStyle()
          Get number property PromptDisplayStyle (PROMPT_DISPLAY_STYLE_PTID).
 java.lang.String getPromptFillPattern()
          Get text property PromptFillPattern (PROMPT_FILL_PATTERN_PTID).
 java.lang.String getPromptFontName()
          Get text property PromptFontName (PROMPT_FONT_NAME_PTID).
 int getPromptFontSize()
          Get number property PromptFontSize (PROMPT_FONT_SIZE_PTID).
 int getPromptFontSpacing()
          Get number property PromptFontSpacing (PROMPT_FONT_SPACING_PTID).
 int getPromptFontStyle()
          Get number property PromptFontStyle (PROMPT_FONT_STYLE_PTID).
 int getPromptFontWeight()
          Get number property PromptFontWeight (PROMPT_FONT_WEIGHT_PTID).
 java.lang.String getPromptForegroundColor()
          Get text property PromptForegroundColor (PROMPT_FOREGROUND_COLOR_PTID).
 int getPromptJustification()
          Get number property PromptJustification (PROMPT_JUSTIFICATION_PTID).
 int getPromptReadingOrder()
          Get number property PromptReadingOrder (PROMPT_READING_ORDER_PTID).
 java.lang.String getPromptVisualAttributeName()
          Get text property PromptVisualAttributeName (PROMPT_VISUALATTRIBUTE_NAME_PTID).
 VisualAttribute getPromptVisualAttributeObject()
          Get object property PromptVisualAttributeObject (PROMPT_VISUALATTRIBUTE_OBJECT_PTID).
 int getPropertyState(int propertyTypeId)
          Returns the current state of the specified property.
 java.lang.String getPropertyValueName(int propertyTypeId, int val)
          Gets the string representation of a given property's value.
 java.lang.String getQualifiedName(boolean includeModule)
          Gets a fully qualified name for the object in the format of: MODULE.OBJECT.CHILD.CHILD...
 int getQueryLength()
          Get number property QueryLength (QUERY_LENGTH_PTID).
 JdapiIterator getRadioButtons()
          Accessor for child RadioButton objects (RADIO_BUTTON_PTID).
 int getReadingOrder()
          Get number property ReadingOrder (READING_ORDER_PTID).
 java.lang.String getRecordGroupName()
          Get text property RecordGroupName (RECORD_GROUP_NAME_PTID).
 RecordGroup getRecordGroupObject()
          Get object property RecordGroupObject (RECORD_GROUP_OBJECT_PTID).
 java.lang.String getRecordVisualAttributeGroupName()
          Get text property RecordVisualAttributeGroupName (RECORD_VISUALATTRIBUTE_GROUP_NAME_PTID).
 VisualAttribute getRecordVisualAttributeGroupObject()
          Get object property RecordVisualAttributeGroupObject (RECORD_VISUALATTRIBUTE_GROUP_OBJECT_PTID).
 int getSizingStyle()
          Get number property SizingStyle (SIZING_STYLE_PTID).
 int getSoundFormat()
          Get number property SoundFormat (SOUND_FORMAT_PTID).
 int getSoundQuality()
          Get number property SoundQuality (SOUND_QUALITY_PTID).
 JdapiObject getSource()
          Get object property Source (SOURCE_PTID).
 int getStringIDProperty(int propertyTypeId)
          Retrieves a special String ID (integer) property from the referred object.
 java.lang.String getStringProperty(int propertyTypeId)
          Retrieves a string property from the referred object.
 JdapiObject getSubclassParent()
          Get Source (SOURCE_PTID) object property, i.e.
 java.lang.String getSummaryBlockName()
          Get text property SummaryBlockName (SUMMARY_BLOCK_NAME_PTID).
 int getSummaryFunction()
          Get number property SummaryFunction (SUMMARY_FUNCTION_PTID).
 java.lang.String getSummaryItemName()
          Get text property SummaryItemName (SUMMARY_ITEM_NAME_PTID).
 java.lang.String getSynchronizedItemName()
          Get text property SynchronizedItemName (SYNCHRONIZED_ITEM_NAME_PTID).
 Item getSynchronizedItemObject()
          Get object property SynchronizedItemObject (SYNCHRONIZED_ITEM_OBJECT_PTID).
 java.lang.String getTabPageName()
          Get text property TabPageName (TABPAGE_NAME_PTID).
 TabPage getTabPageObject()
          Get object property TabPageObject (TABPAGE_OBJECT_PTID).
 java.lang.String getTooltip()
          Get text property Tooltip (TOOLTIP_PTID).
 java.lang.String getTooltipVisualAttributeGroup()
          Get text property TooltipVisualAttributeGroup (TOOLTIP_VISUALATTRIBUTE_GROUP_PTID).
 java.lang.String getTreeDataQuery()
          Get text property TreeDataQuery (TREE_DATA_QUERY_PTID).
 java.lang.String getTreeRecordGroup()
          Get text property TreeRecordGroup (TREE_RECORD_GROUP_PTID).
 JdapiIterator getTriggers()
          Accessor for child Trigger objects (TRIGGER_PTID).
 int getTypeId()
          Gets the HtmlForms object type ID.
 java.lang.String getUncheckedValue()
          Get text property UncheckedValue (UNCHECKED_VALUE_PTID).
 java.lang.String getVisualAttributeName()
          Get text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).
 VisualAttribute getVisualAttributeObject()
          Get object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).
 int getWidth()
          Get number property Width (WIDTH_PTID).
 int getWrapStyle()
          Get number property WrapStyle (WRAP_STYLE_PTID).
 int getXPosition()
          Get number property XPosition (X_POSITION_PTID).
 int getYPosition()
          Get number property YPosition (Y_POSITION_PTID).
 boolean hasDefaultedProperty(int propertyTypeId)
          Checks if a property is set to it's default value.
 boolean hasInheritedProperty(int propertyTypeId)
          Checks if a property is inherited.
 boolean hasOverriddenProperty(int propertyTypeId)
          Determine whether the object referred has a property of the given type id with an overridden value.
 boolean hasProperty(int propertyTypeId)
          Checks if the object has a given property.
 void inheritProperty(int propertyTypeId)
          Resets a property to it's default value (confusing name eh?).
 void insertElement(int index, java.lang.String label, java.lang.String value)
          Insert a row into the list elements of a list item.
 boolean isAutoHint()
          Get boolean property AutoHint (AUTO_HINT_PTID).
 boolean isAutoSkip()
          Get boolean property AutoSkip (AUTO_SKIP_PTID).
 boolean isCaseInsensitiveQuery()
          Get boolean property CaseInsensitiveQuery (CASE_INSENSITIVE_QUERY_PTID).
 boolean isConcealData()
          Get boolean property ConcealData (CONCEAL_DATA_PTID).
 boolean isDatabaseItem()
          Get boolean property DatabaseItem (DATABASE_ITEM_PTID).
 boolean isDefaultButton()
          Get boolean property DefaultButton (DEFAULT_BUTTON_PTID).
 boolean isDirtyInfo()
          Get boolean property DirtyInfo (DIRTY_INFO_PTID).
 boolean isEnabled()
          Get boolean property Enabled (ENABLED_PTID).
 boolean isFixedLength()
          Get boolean property FixedLength (FIXED_LENGTH_PTID).
 boolean isIconic()
          Get boolean property Iconic (ICONIC_PTID).
 boolean isInsertAllowed()
          Get boolean property InsertAllowed (INSERT_ALLOWED_PTID).
 boolean isKeepCursorPosition()
          Get boolean property KeepCursorPosition (KEEP_CURSOR_POSITION_PTID).
 boolean isKeyboardNavigable()
          Get boolean property KeyboardNavigable (KEYBOARD_NAVIGABLE_PTID).
 boolean isLockRecord()
          Get boolean property LockRecord (LOCK_RECORD_PTID).
 boolean isMouseNavigate()
          Get boolean property MouseNavigate (MOUSE_NAVIGATE_PTID).
 boolean isMultiLine()
          Get boolean property MultiLine (MULTI_LINE_PTID).
 boolean isOleInPlaceAction()
          Get boolean property OleInPlaceAction (OLE_IN_PLACE_ACTION_PTID).
 boolean isOleInsideOutSupport()
          Get boolean property OleInsideOutSupport (OLE_INSIDE_OUT_SUPPORT_PTID).
 boolean isOleShowPopupMenu()
          Get boolean property OleShowPopupMenu (OLE_SHOW_POPUP_MENU_PTID).
 boolean isOleShowTenantTypeType()
          Get boolean property OleShowTenantTypeType (OLE_SHOW_TENANTTYPE_TYPE_PTID).
 boolean isPrimaryKey()
          Get boolean property PrimaryKey (PRIMARY_KEY_PTID).
 boolean isQueryAllowed()
          Get boolean property QueryAllowed (QUERY_ALLOWED_PTID).
 boolean isQueryOnly()
          Get boolean property QueryOnly (QUERY_ONLY_PTID).
 boolean isRendered()
          Get boolean property Rendered (RENDERED_PTID).
 boolean isRequired()
          Get boolean property Required (REQUIRED_PTID).
 boolean isShowFastForward()
          Get boolean property ShowFastForward (SHOW_FAST_FORWARD_PTID).
 boolean isShowHorizontalScrollbar()
          Get boolean property ShowHorizontalScrollbar (SHOW_HORIZONTAL_SCROLLBAR_PTID).
 boolean isShowPalette()
          Get boolean property ShowPalette (SHOW_PALETTE_PTID).
 boolean isShowPlay()
          Get boolean property ShowPlay (SHOW_PLAY_PTID).
 boolean isShowRecord()
          Get boolean property ShowRecord (SHOW_RECORD_PTID).
 boolean isShowRewind()
          Get boolean property ShowRewind (SHOW_REWIND_PTID).
 boolean isShowSlider()
          Get boolean property ShowSlider (SHOW_SLIDER_PTID).
 boolean isShowTime()
          Get boolean property ShowTime (SHOW_TIME_PTID).
 boolean isShowVerticalScrollbar()
          Get boolean property ShowVerticalScrollbar (SHOW_VERTICAL_SCROLLBAR_PTID).
 boolean isShowVolume()
          Get boolean property ShowVolume (SHOW_VOLUME_PTID).
 boolean isSubclassed()
          Checks if the object is subclassed from another object.
 boolean isSubclassSubObject()
          Get boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).
 boolean isTreeAllowEmpBranch()
          Get boolean property TreeAllowEmpBranch (TREE_ALLOW_EMP_BRANCH_PTID).
 boolean isTreeMultiSelect()
          Get boolean property TreeMultiSelect (TREE_MULTI_SELECT_PTID).
 boolean isTreeShowLines()
          Get boolean property TreeShowLines (TREE_SHOW_LINES_PTID).
 boolean isTreeShowSymbol()
          Get boolean property TreeShowSymbol (TREE_SHOW_SYMBOL_PTID).
 boolean isUpdateAllowed()
          Get boolean property UpdateAllowed (UPDATE_ALLOWED_PTID).
 boolean isUpdateCommit()
          Get boolean property UpdateCommit (UPDATE_COMMIT_PTID).
 boolean isUpdateIfNull()
          Get boolean property UpdateIfNull (UPDATE_IF_NULL_PTID).
 boolean isUpdateQuery()
          Get boolean property UpdateQuery (UPDATE_QUERY_PTID).
 boolean isValidateFromList()
          Get boolean property ValidateFromList (VALIDATE_FROM_LIST_PTID).
 boolean isValidFormsObject()
          Determines whether this Java instance references a valid Forms object.
 boolean isVisible()
          Get boolean property Visible (VISIBLE_PTID).
 void move(JdapiObject next)
          Reorders an object with respect to its siblings in the collection it belongs to.
 int queryType()
          Returns the FormAPI object type ID (x_OTID in JdapiTypes).
 void reattach()
          Reattaches subclassed object.
 void setAccessKey(java.lang.String value)
          Sets text property AccessKey (ACCESS_KEY_PTID).
 void setAudioChannels(int value)
          Sets number property AudioChannels (AUDIO_CHANNELS_PTID).
 void setAutoHint(boolean value)
          Sets boolean property AutoHint (AUTO_HINT_PTID).
 void setAutoSkip(boolean value)
          Sets boolean property AutoSkip (AUTO_SKIP_PTID).
 void setBackColor(java.lang.String value)
          Sets text property BackColor (BACK_COLOR_PTID).
 void setBevel(int value)
          Sets number property Bevel (BEVEL_PTID).
 void setBooleanProperty(int propertyTypeId, boolean propertyValue)
          Sets the value of the specified boolean property belonging to the referred object.
 void setCalculateMode(int value)
          Sets number property CalculateMode (CALCULATE_MODE_PTID).
 void setCanvasName(java.lang.String value)
          Sets text property CanvasName (CANVAS_NAME_PTID).
 void setCanvasObject(Canvas value)
          Set object property CanvasObject (CANVAS_OBJECT_PTID).
 void setCaseInsensitiveQuery(boolean value)
          Sets boolean property CaseInsensitiveQuery (CASE_INSENSITIVE_QUERY_PTID).
 void setCaseRestriction(int value)
          Sets number property CaseRestriction (CASE_RESTRICTION_PTID).
 void setCheckBoxOtherValues(int value)
          Sets number property CheckBoxOtherValues (CHECK_BOX_OTHER_VALUES_PTID).
 void setCheckedValue(java.lang.String value)
          Sets text property CheckedValue (CHECKED_VALUE_PTID).
 void setClientInfo(java.lang.Object clientInfo)
          Sets the client information.
 void setColumnName(java.lang.String value)
          Sets text property ColumnName (COLUMN_NAME_PTID).
 void setComment(java.lang.String value)
          Sets text property Comment (COMMENT_PTID).
 void setCommMode(int value)
          Sets number property CommMode (COMM_MODE_PTID).
 void setCompress(int value)
          Sets number property Compress (COMPRESS_PTID).
 void setCompressionQuality(int value)
          Sets number property CompressionQuality (COMPRESSION_QUALITY_PTID).
 void setConcealData(boolean value)
          Sets boolean property ConcealData (CONCEAL_DATA_PTID).
 void setCopyValueFromItem(java.lang.String value)
          Sets text property CopyValueFromItem (COPY_VALUE_FROM_ITEM_PTID).
 void setDatabaseItem(boolean value)
          Sets boolean property DatabaseItem (DATABASE_ITEM_PTID).
 void setDataLengthSemantics(int value)
          Sets number property DataLengthSemantics (DATA_LENGTH_SEMANTICS_PTID).
 void setDataSourceBlock(java.lang.String value)
          Sets text property DataSourceBlock (DATA_SOURCE_BLOCK_PTID).
 void setDataSourceXAxis(java.lang.String value)
          Sets text property DataSourceXAxis (DATA_SOURCE_X_AXIS_PTID).
 void setDataSourceYAxis(java.lang.String value)
          Sets text property DataSourceYAxis (DATA_SOURCE_Y_AXIS_PTID).
 void setDataType(int value)
          Sets number property DataType (DATA_TYPE_PTID).
 void setDefaultButton(boolean value)
          Sets boolean property DefaultButton (DEFAULT_BUTTON_PTID).
 void setDirtyInfo(boolean value)
          Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
 void setDisplayQuality(int value)
          Sets number property DisplayQuality (DISPLAY_QUALITY_PTID).
 void setDistanceBetweenRecords(int value)
          Sets number property DistanceBetweenRecords (DISTANCE_BETWEEN_RECORDS_PTID).
 void setEditName(java.lang.String value)
          Sets text property EditName (EDIT_NAME_PTID).
 void setEditObject(Editor value)
          Set object property EditObject (EDIT_OBJECT_PTID).
 void setEditXPosition(int value)
          Sets number property EditXPosition (EDIT_X_POSITION_PTID).
 void setEditYPosition(int value)
          Sets number property EditYPosition (EDIT_Y_POSITION_PTID).
 void setEnabled(boolean value)
          Sets boolean property Enabled (ENABLED_PTID).
 void setExecuteMode(int value)
          Sets number property ExecuteMode (EXECUTE_MODE_PTID).
 void setFilename(java.lang.String value)
          Sets text property Filename (FILENAME_PTID).
 void setFillPattern(java.lang.String value)
          Sets text property FillPattern (FILL_PATTERN_PTID).
 void setFixedLength(boolean value)
          Sets boolean property FixedLength (FIXED_LENGTH_PTID).
 void setFontName(java.lang.String value)
          Sets text property FontName (FONT_NAME_PTID).
 void setFontSize(int value)
          Sets number property FontSize (FONT_SIZE_PTID).
 void setFontSpacing(int value)
          Sets number property FontSpacing (FONT_SPACING_PTID).
 void setFontStyle(int value)
          Sets number property FontStyle (FONT_STYLE_PTID).
 void setFontWeight(int value)
          Sets number property FontWeight (FONT_WEIGHT_PTID).
 void setForegroundColor(java.lang.String value)
          Sets text property ForegroundColor (FOREGROUND_COLOR_PTID).
 void setFormatMask(java.lang.String value)
          Sets text property FormatMask (FORMAT_MASK_PTID).
 void setFormula(java.lang.String value)
          Sets text property Formula (FORMULA_PTID).
 void setHeight(int value)
          Sets number property Height (HEIGHT_PTID).
 void setHelpBookTopic(java.lang.String value)
          Sets text property HelpBookTopic (HELP_BOOK_TOPIC_PTID).
 void setHighestAllowedValue(java.lang.String value)
          Sets text property HighestAllowedValue (HIGHEST_ALLOWED_VALUE_PTID).
 void setHint(java.lang.String value)
          Sets text property Hint (HINT_PTID).
 void setIconFilename(java.lang.String value)
          Sets text property IconFilename (ICON_FILENAME_PTID).
 void setIconic(boolean value)
          Sets boolean property Iconic (ICONIC_PTID).
 void setImageDepth(int value)
          Sets number property ImageDepth (IMAGE_DEPTH_PTID).
 void setImageFormat(int value)
          Sets number property ImageFormat (IMAGE_FORMAT_PTID).
 void setImplementationClass(java.lang.String value)
          Sets text property ImplementationClass (IMPLEMENTATION_CLASS_PTID).
 void setInitializeKeyboardDirection(int value)
          Sets number property InitializeKeyboardDirection (INITIALIZE_KEYBOARD_DIRECTION_PTID).
 void setInitializeValue(java.lang.String value)
          Sets text property InitializeValue (INITIALIZE_VALUE_PTID).
 void setInsertAllowed(boolean value)
          Sets boolean property InsertAllowed (INSERT_ALLOWED_PTID).
 void setIntegerProperty(int propertyTypeId, int propertyValue)
          Sets the value of the specified object integer property.
 void setItemsDisplay(int value)
          Sets number property ItemsDisplay (ITEMS_DISPLAY_PTID).
 void setItemType(int value)
          Sets number property ItemType (ITEM_TYPE_PTID).
 void setJustification(int value)
          Sets number property Justification (JUSTIFICATION_PTID).
 void setKeepCursorPosition(boolean value)
          Sets boolean property KeepCursorPosition (KEEP_CURSOR_POSITION_PTID).
 void setKeyboardNavigable(boolean value)
          Sets boolean property KeyboardNavigable (KEYBOARD_NAVIGABLE_PTID).
 void setKeyboardState(int value)
          Sets number property KeyboardState (KEYBOARD_STATE_PTID).
 void setLabel(java.lang.String value)
          Sets text property Label (LABEL_PTID).
 void setLanguageDirection(int value)
          Sets number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
 void setListStyle(int value)
          Sets number property ListStyle (LIST_STYLE_PTID).
 void setLockRecord(boolean value)
          Sets boolean property LockRecord (LOCK_RECORD_PTID).
 void setLovName(java.lang.String value)
          Sets text property LovName (LOV_NAME_PTID).
 void setLovObject(LOV value)
          Set object property LovObject (LOV_OBJECT_PTID).
 void setLovXPosition(int value)
          Sets number property LovXPosition (LOV_X_POSITION_PTID).
 void setLovYPosition(int value)
          Sets number property LovYPosition (LOV_Y_POSITION_PTID).
 void setLowestAllowedValue(java.lang.String value)
          Sets text property LowestAllowedValue (LOWEST_ALLOWED_VALUE_PTID).
 void setMaximumLength(int value)
          Sets number property MaximumLength (MAXIMUM_LENGTH_PTID).
 void setMouseNavigate(boolean value)
          Sets boolean property MouseNavigate (MOUSE_NAVIGATE_PTID).
 void setMultiLine(boolean value)
          Sets boolean property MultiLine (MULTI_LINE_PTID).
 void setName(java.lang.String value)
          Sets text property Name (NAME_PTID).
 void setNextNavigationItemName(java.lang.String value)
          Sets text property NextNavigationItemName (NEXT_NAVIGATION_ITEM_NAME_PTID).
 void setNextNavigationItemObject(Item value)
          Set object property NextNavigationItemObject (NEXT_NAVIGATION_ITEM_OBJECT_PTID).
 void setObjectProperty(int propertyTypeId, JdapiObject propertyValue)
          Sets the value of the specified object object property value.
protected  void setObjProp(int propertyTypeId, long val)
          Internal method used to set an object property.
 void setOleActionStyle(int value)
          Sets number property OleActionStyle (OLE_ACTION_STYLE_PTID).
 void setOleClass(java.lang.String value)
          Sets text property OleClass (OLE_CLASS_PTID).
 void setOleInPlaceAction(boolean value)
          Sets boolean property OleInPlaceAction (OLE_IN_PLACE_ACTION_PTID).
 void setOleInsideOutSupport(boolean value)
          Sets boolean property OleInsideOutSupport (OLE_INSIDE_OUT_SUPPORT_PTID).
 void setOlePopupMenuItems(int value)
          Sets number property OlePopupMenuItems (OLE_POPUP_MENU_ITEMS_PTID).
 void setOleResizStyle(int value)
          Sets number property OleResizStyle (OLE_RESIZ_STYLE_PTID).
 void setOleShowPopupMenu(boolean value)
          Sets boolean property OleShowPopupMenu (OLE_SHOW_POPUP_MENU_PTID).
 void setOleShowTenantTypeType(boolean value)
          Sets boolean property OleShowTenantTypeType (OLE_SHOW_TENANTTYPE_TYPE_PTID).
 void setOleTenantTypeAspect(int value)
          Sets number property OleTenantTypeAspect (OLE_TENANTTYPE_ASPECT_PTID).
 void setOleTenantTypeType(int value)
          Sets number property OleTenantTypeType (OLE_TENANTTYPE_TYPE_PTID).
 void setOtherValues(java.lang.String value)
          Sets text property OtherValues (OTHER_VALUES_PTID).
 void setParentFilename(java.lang.String value)
          Sets text property ParentFilename (PARENT_FILENAME_PTID).
 void setParentFilepath(java.lang.String value)
          Sets text property ParentFilepath (PARENT_FILEPATH_PTID).
 void setParentModule(java.lang.String value)
          Sets text property ParentModule (PARENT_MODULE_PTID).
 void setParentModuleType(int value)
          Sets number property ParentModuleType (PARENT_MODULETYPE_PTID).
 void setParentName(java.lang.String value)
          Sets text property ParentName (PARENT_NAME_PTID).
 void setParentSourceLevel1ObjectName(java.lang.String value)
          Sets text property ParentSourceLevel1ObjectName (PARENT_SOURCELEVEL1OBJECT_NAME_PTID).
 void setParentSourceLevel1ObjectType(int value)
          Sets number property ParentSourceLevel1ObjectType (PARENT_SOURCELEVEL1OBJECT_TYPE_PTID).
 void setParentType(int value)
          Sets number property ParentType (PARENT_TYPE_PTID).
 void setPersistentClientInfo(Blob val)
          Sets persistent client info for this object.
 void setPersistentClientInfo(java.io.Serializable obj)
          Serializes any Java object which supports the Serializable interface to this object's Persistent Client Info.
 void setPersistentClientInfoLength(int value)
          Sets number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
 void setPopupMenuName(java.lang.String value)
          Sets text property PopupMenuName (POPUP_MENU_NAME_PTID).
 void setPopupMenuObject(Menu value)
          Set object property PopupMenuObject (POPUP_MENU_OBJECT_PTID).
 void setPopupVisualAttributeObject(VisualAttribute value)
          Set object property PopupVisualAttributeObject (POPUP_VISUALATTRIBUTE_OBJECT_PTID).
 void setPreviousNavigationItemName(java.lang.String value)
          Sets text property PreviousNavigationItemName (PREVIOUS_NAVIGATION_ITEM_NAME_PTID).
 void setPreviousNavigationItemObject(Item value)
          Set object property PreviousNavigationItemObject (PREVIOUS_NAVIGATION_ITEM_OBJECT_PTID).
 void setPrimaryKey(boolean value)
          Sets boolean property PrimaryKey (PRIMARY_KEY_PTID).
 void setPrompt(java.lang.String value)
          Sets text property Prompt (PROMPT_PTID).
 void setPromptAlign(int value)
          Sets number property PromptAlign (PROMPT_ALIGN_PTID).
 void setPromptAlignOffset(int value)
          Sets number property PromptAlignOffset (PROMPT_ALIGN_OFFSET_PTID).
 void setPromptAttachmentEdge(int value)
          Sets number property PromptAttachmentEdge (PROMPT_ATTACHMENT_EDGE_PTID).
 void setPromptAttachmentOffset(int value)
          Sets number property PromptAttachmentOffset (PROMPT_ATTACHMENT_OFFSET_PTID).
 void setPromptBackColor(java.lang.String value)
          Sets text property PromptBackColor (PROMPT_BACK_COLOR_PTID).
 void setPromptDisplayStyle(int value)
          Sets number property PromptDisplayStyle (PROMPT_DISPLAY_STYLE_PTID).
 void setPromptFillPattern(java.lang.String value)
          Sets text property PromptFillPattern (PROMPT_FILL_PATTERN_PTID).
 void setPromptFontName(java.lang.String value)
          Sets text property PromptFontName (PROMPT_FONT_NAME_PTID).
 void setPromptFontSize(int value)
          Sets number property PromptFontSize (PROMPT_FONT_SIZE_PTID).
 void setPromptFontSpacing(int value)
          Sets number property PromptFontSpacing (PROMPT_FONT_SPACING_PTID).
 void setPromptFontStyle(int value)
          Sets number property PromptFontStyle (PROMPT_FONT_STYLE_PTID).
 void setPromptFontWeight(int value)
          Sets number property PromptFontWeight (PROMPT_FONT_WEIGHT_PTID).
 void setPromptForegroundColor(java.lang.String value)
          Sets text property PromptForegroundColor (PROMPT_FOREGROUND_COLOR_PTID).
 void setPromptJustification(int value)
          Sets number property PromptJustification (PROMPT_JUSTIFICATION_PTID).
 void setPromptReadingOrder(int value)
          Sets number property PromptReadingOrder (PROMPT_READING_ORDER_PTID).
 void setPromptVisualAttributeName(java.lang.String value)
          Sets text property PromptVisualAttributeName (PROMPT_VISUALATTRIBUTE_NAME_PTID).
 void setPromptVisualAttributeObject(VisualAttribute value)
          Set object property PromptVisualAttributeObject (PROMPT_VISUALATTRIBUTE_OBJECT_PTID).
 void setQueryAllowed(boolean value)
          Sets boolean property QueryAllowed (QUERY_ALLOWED_PTID).
 void setQueryLength(int value)
          Sets number property QueryLength (QUERY_LENGTH_PTID).
 void setQueryOnly(boolean value)
          Sets boolean property QueryOnly (QUERY_ONLY_PTID).
 void setReadingOrder(int value)
          Sets number property ReadingOrder (READING_ORDER_PTID).
 void setRecordGroupName(java.lang.String value)
          Sets text property RecordGroupName (RECORD_GROUP_NAME_PTID).
 void setRecordGroupObject(RecordGroup value)
          Set object property RecordGroupObject (RECORD_GROUP_OBJECT_PTID).
 void setRecordVisualAttributeGroupName(java.lang.String value)
          Sets text property RecordVisualAttributeGroupName (RECORD_VISUALATTRIBUTE_GROUP_NAME_PTID).
 void setRecordVisualAttributeGroupObject(VisualAttribute value)
          Set object property RecordVisualAttributeGroupObject (RECORD_VISUALATTRIBUTE_GROUP_OBJECT_PTID).
 void setRendered(boolean value)
          Sets boolean property Rendered (RENDERED_PTID).
 void setRequired(boolean value)
          Sets boolean property Required (REQUIRED_PTID).
 void setShowFastForward(boolean value)
          Sets boolean property ShowFastForward (SHOW_FAST_FORWARD_PTID).
 void setShowHorizontalScrollbar(boolean value)
          Sets boolean property ShowHorizontalScrollbar (SHOW_HORIZONTAL_SCROLLBAR_PTID).
 void setShowPalette(boolean value)
          Sets boolean property ShowPalette (SHOW_PALETTE_PTID).
 void setShowPlay(boolean value)
          Sets boolean property ShowPlay (SHOW_PLAY_PTID).
 void setShowRecord(boolean value)
          Sets boolean property ShowRecord (SHOW_RECORD_PTID).
 void setShowRewind(boolean value)
          Sets boolean property ShowRewind (SHOW_REWIND_PTID).
 void setShowSlider(boolean value)
          Sets boolean property ShowSlider (SHOW_SLIDER_PTID).
 void setShowTime(boolean value)
          Sets boolean property ShowTime (SHOW_TIME_PTID).
 void setShowVerticalScrollbar(boolean value)
          Sets boolean property ShowVerticalScrollbar (SHOW_VERTICAL_SCROLLBAR_PTID).
 void setShowVolume(boolean value)
          Sets boolean property ShowVolume (SHOW_VOLUME_PTID).
 void setSizingStyle(int value)
          Sets number property SizingStyle (SIZING_STYLE_PTID).
 void setSoundFormat(int value)
          Sets number property SoundFormat (SOUND_FORMAT_PTID).
 void setSoundQuality(int value)
          Sets number property SoundQuality (SOUND_QUALITY_PTID).
 void setStringProperty(int propertyTypeId, java.lang.String propertyValue)
          Sets the value of the specified string property for the object.
 void setSubclassParent(JdapiObject parent)
          Change the subclassing parent of the object referred.
 void setSubclassSubObject(boolean value)
          Sets boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).
 void setSummaryBlockName(java.lang.String value)
          Sets text property SummaryBlockName (SUMMARY_BLOCK_NAME_PTID).
 void setSummaryFunction(int value)
          Sets number property SummaryFunction (SUMMARY_FUNCTION_PTID).
 void setSummaryItemName(java.lang.String value)
          Sets text property SummaryItemName (SUMMARY_ITEM_NAME_PTID).
 void setSynchronizedItemName(java.lang.String value)
          Sets text property SynchronizedItemName (SYNCHRONIZED_ITEM_NAME_PTID).
 void setSynchronizedItemObject(Item value)
          Set object property SynchronizedItemObject (SYNCHRONIZED_ITEM_OBJECT_PTID).
 void setTabPageName(java.lang.String value)
          Sets text property TabPageName (TABPAGE_NAME_PTID).
 void setTabPageObject(TabPage value)
          Set object property TabPageObject (TABPAGE_OBJECT_PTID).
 void setTooltip(java.lang.String value)
          Sets text property Tooltip (TOOLTIP_PTID).
 void setTooltipVisualAttributeGroup(java.lang.String value)
          Sets text property TooltipVisualAttributeGroup (TOOLTIP_VISUALATTRIBUTE_GROUP_PTID).
 void setTreeAllowEmpBranch(boolean value)
          Sets boolean property TreeAllowEmpBranch (TREE_ALLOW_EMP_BRANCH_PTID).
 void setTreeDataQuery(java.lang.String value)
          Sets text property TreeDataQuery (TREE_DATA_QUERY_PTID).
 void setTreeMultiSelect(boolean value)
          Sets boolean property TreeMultiSelect (TREE_MULTI_SELECT_PTID).
 void setTreeRecordGroup(java.lang.String value)
          Sets text property TreeRecordGroup (TREE_RECORD_GROUP_PTID).
 void setTreeShowLines(boolean value)
          Sets boolean property TreeShowLines (TREE_SHOW_LINES_PTID).
 void setTreeShowSymbol(boolean value)
          Sets boolean property TreeShowSymbol (TREE_SHOW_SYMBOL_PTID).
 void setUncheckedValue(java.lang.String value)
          Sets text property UncheckedValue (UNCHECKED_VALUE_PTID).
 void setUpdateAllowed(boolean value)
          Sets boolean property UpdateAllowed (UPDATE_ALLOWED_PTID).
 void setUpdateCommit(boolean value)
          Sets boolean property UpdateCommit (UPDATE_COMMIT_PTID).
 void setUpdateIfNull(boolean value)
          Sets boolean property UpdateIfNull (UPDATE_IF_NULL_PTID).
 void setUpdateQuery(boolean value)
          Sets boolean property UpdateQuery (UPDATE_QUERY_PTID).
 void setValidateFromList(boolean value)
          Sets boolean property ValidateFromList (VALIDATE_FROM_LIST_PTID).
 void setVisible(boolean value)
          Sets boolean property Visible (VISIBLE_PTID).
 void setVisualAttributeName(java.lang.String value)
          Sets text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).
 void setVisualAttributeObject(VisualAttribute value)
          Set object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).
 void setWidth(int value)
          Sets number property Width (WIDTH_PTID).
 void setWrapStyle(int value)
          Sets number property WrapStyle (WRAP_STYLE_PTID).
 void setXPosition(int value)
          Sets number property XPosition (X_POSITION_PTID).
 void setYPosition(int value)
          Sets number property YPosition (Y_POSITION_PTID).
 java.lang.String toString()
          Converts and returns the object properties to string format.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

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 java.lang.Object m_clientInfo
Client info object held against this Forms object.
Constructor Detail

Item

public Item(Block parent,
            java.lang.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,
            java.lang.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,
            java.lang.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(ObjectGroup parent,
            java.lang.String name)
Constructor used to create Item objects in the context of a ObjectGroup parent object.
Parameters:
parent - Parent object
name - Name of the new object

Item

public Item(ObjectGroup parent,
            java.lang.String name,
            Item base)
Constructor used to create Item objects in the context of a ObjectGroup 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(ObjectGroup parent,
            java.lang.String name,
            PropertyClass base)
Constructor used to create Item objects in the context of a ObjectGroup 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,
            java.lang.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,
            java.lang.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,
            java.lang.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:
pd2fctx - C pointer to Forms context
pd2fitm - C pointer to Forms object
Method Detail

getTypeId

public int getTypeId()
Gets the HtmlForms object type ID.
Overrides:
getTypeId in class oracle.forms.jdapi.BaseFormsObject
Returns:
X_OTID ID for this object type

clone

public Item clone(Block parent,
                  java.lang.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(ObjectGroup parent,
                  java.lang.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,
                  java.lang.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,
                        java.lang.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(ObjectGroup parent,
                        java.lang.String name)
Find an instance of Item that is a child of a ObjectGroup.
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,
                        java.lang.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,
                          java.lang.String label,
                          java.lang.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 java.lang.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 java.lang.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 java.lang.String getAccessKey()
Get text property AccessKey (ACCESS_KEY_PTID).
Returns:
Value of property

setAccessKey

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

getBackColor

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

setBackColor

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

getCheckedValue

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

setCheckedValue

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

getCanvasName

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

setCanvasName

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

getColumnName

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

setColumnName

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

getComment

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

setComment

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

getCopyValueFromItem

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

setCopyValueFromItem

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

getDataSourceBlock

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

setDataSourceBlock

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

getDataSourceXAxis

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

setDataSourceXAxis

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

getDataSourceYAxis

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

setDataSourceYAxis

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

getEditName

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

setEditName

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

getFillPattern

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

setFillPattern

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

getFilename

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

setFilename

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

getFormatMask

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

setFormatMask

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

getFontName

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

setFontName

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

getForegroundColor

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

setForegroundColor

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

getFormula

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

setFormula

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

getHelpBookTopic

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

setHelpBookTopic

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

getHighestAllowedValue

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

setHighestAllowedValue

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

getHint

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

setHint

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

getIconFilename

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

setIconFilename

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

getImplementationClass

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

setImplementationClass

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

getInitializeValue

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

setInitializeValue

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

getLabel

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

setLabel

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

getLovName

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

setLovName

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

getLowestAllowedValue

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

setLowestAllowedValue

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

getName

public java.lang.String getName()
Get text property Name (NAME_PTID).
Overrides:
getName in class oracle.forms.jdapi.BaseFormsObject
Returns:
Value of property

setName

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

getNextNavigationItemName

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

setNextNavigationItemName

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

getOleClass

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

setOleClass

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

getOtherValues

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

setOtherValues

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

getParentFilename

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

setParentFilename

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

getParentFilepath

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

setParentFilepath

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

getParentModule

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

setParentModule

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

getParentName

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

setParentName

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

getParentSourceLevel1ObjectName

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

setParentSourceLevel1ObjectName

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

getPopupMenuName

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

setPopupMenuName

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

getPreviousNavigationItemName

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

setPreviousNavigationItemName

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

getPrompt

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

setPrompt

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

getPromptBackColor

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

setPromptBackColor

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

getPromptFillPattern

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

setPromptFillPattern

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

getPromptFontName

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

setPromptFontName

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

getPromptForegroundColor

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

setPromptForegroundColor

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

getPromptVisualAttributeName

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

setPromptVisualAttributeName

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

getRecordGroupName

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

setRecordGroupName

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

getRecordVisualAttributeGroupName

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

setRecordVisualAttributeGroupName

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

getSummaryBlockName

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

setSummaryBlockName

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

getSummaryItemName

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

setSummaryItemName

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

getSynchronizedItemName

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

setSynchronizedItemName

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

getTabPageName

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

setTabPageName

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

getTooltip

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

setTooltip

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

getTooltipVisualAttributeGroup

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

setTooltipVisualAttributeGroup

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

getTreeDataQuery

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

setTreeDataQuery

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

getTreeRecordGroup

public java.lang.String getTreeRecordGroup()
Get text property TreeRecordGroup (TREE_RECORD_GROUP_PTID).
Returns:
Value of property

setTreeRecordGroup

public void setTreeRecordGroup(java.lang.String value)
Sets text property TreeRecordGroup (TREE_RECORD_GROUP_PTID).
Parameters:
value - Value to set property to

getUncheckedValue

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

setUncheckedValue

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

getVisualAttributeName

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

setVisualAttributeName

public void setVisualAttributeName(java.lang.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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

isShowPalette

public boolean isShowPalette()
Get boolean property ShowPalette (SHOW_PALETTE_PTID).
Returns:
Value of property

setShowPalette

public void setShowPalette(boolean value)
Sets boolean property ShowPalette (SHOW_PALETTE_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
Overrides:
getModule in class oracle.forms.jdapi.BaseFormsObject
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
Overrides:
getOwner in class oracle.forms.jdapi.BaseFormsObject
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(java.lang.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 java.lang.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 java.lang.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(java.io.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:
val - 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:
object - 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,
                         java.lang.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 java.lang.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 java.lang.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
Following copied from interface: oracle.forms.jdapi.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:
nextObject - 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 java.lang.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 java.lang.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
Following copied from interface: oracle.forms.jdapi.JdapiObject
Parameters:
propertyTypeId - Property number
val - Value of property
Returns:
String representation

getIntegerPropertyString

public java.lang.String getIntegerPropertyString(int propertyTypeId)
Description copied from interface: JdapiObject
Gets a numeric (long) property value's text representation.
Specified by:
getIntegerPropertyString in interface JdapiObject
Following copied from interface: oracle.forms.jdapi.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:
oracle.forms.builder.jfapi.ContextCache, #getObjectProp

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
Following copied from interface: oracle.forms.jdapi.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
Following copied from interface: oracle.forms.jdapi.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
Following copied from interface: oracle.forms.jdapi.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,
                              java.lang.String propertyValue)
Description copied from interface: JdapiObject
Sets the value of the specified string property for the object.
Specified by:
setStringProperty in interface JdapiObject
Following copied from interface: oracle.forms.jdapi.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:
#setObjectProp

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.

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.

createSubclassedChild

public JdapiObject createSubclassedChild(JdapiObject childOwner,
                                         java.lang.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 java.lang.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 java.lang.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.