|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.forms.jdapi.BaseFormsObject | +--oracle.forms.jdapi.Item
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.
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 |
protected transient long m_pd2fob
protected transient java.lang.Object m_clientInfo
Constructor Detail |
public Item(Block parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Item(Block parent, java.lang.String name, Item base)
parent
- Parent objectname
- Name of the new objectbase
- Item object to derive frompublic Item(Block parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Item(ObjectGroup parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Item(ObjectGroup parent, java.lang.String name, Item base)
parent
- Parent objectname
- Name of the new objectbase
- Item object to derive frompublic Item(ObjectGroup parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Item(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectpublic Item(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, Item base)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectbase
- Item object to derive frompublic Item(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, PropertyClass base)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectbase
- PropertyClass object to derive fromprotected Item(long pd2fitm)
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);
pd2fctx
- C pointer to Forms contextpd2fitm
- C pointer to Forms objectMethod Detail |
public int getTypeId()
getTypeId
in class oracle.forms.jdapi.BaseFormsObject
public Item clone(Block parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Item clone(ObjectGroup parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Item clone(ObjectLibraryTab parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static Item find(Block parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Item find(ObjectGroup parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Item find(ObjectLibraryTab parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic void insertElement(int index, java.lang.String label, java.lang.String value)
index
- Index to insert row atlabel
- List element labelvalue
- List element valuepublic void deleteElement(int index)
index
- Index of row to deletepublic java.lang.String getElementLabel(int index)
index
- Index of row which contains the labelpublic java.lang.String getElementValue(int index)
index
- Index of row which contains the valuepublic java.lang.String getAccessKey()
public void setAccessKey(java.lang.String value)
value
- Value to set property topublic java.lang.String getBackColor()
public void setBackColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getCheckedValue()
public void setCheckedValue(java.lang.String value)
value
- Value to set property topublic java.lang.String getCanvasName()
public void setCanvasName(java.lang.String value)
value
- Value to set property topublic java.lang.String getColumnName()
public void setColumnName(java.lang.String value)
value
- Value to set property topublic java.lang.String getComment()
public void setComment(java.lang.String value)
value
- Value to set property topublic java.lang.String getCopyValueFromItem()
public void setCopyValueFromItem(java.lang.String value)
value
- Value to set property topublic java.lang.String getDataSourceBlock()
public void setDataSourceBlock(java.lang.String value)
value
- Value to set property topublic java.lang.String getDataSourceXAxis()
public void setDataSourceXAxis(java.lang.String value)
value
- Value to set property topublic java.lang.String getDataSourceYAxis()
public void setDataSourceYAxis(java.lang.String value)
value
- Value to set property topublic java.lang.String getEditName()
public void setEditName(java.lang.String value)
value
- Value to set property topublic java.lang.String getFillPattern()
public void setFillPattern(java.lang.String value)
value
- Value to set property topublic java.lang.String getFilename()
public void setFilename(java.lang.String value)
value
- Value to set property topublic java.lang.String getFormatMask()
public void setFormatMask(java.lang.String value)
value
- Value to set property topublic java.lang.String getFontName()
public void setFontName(java.lang.String value)
value
- Value to set property topublic java.lang.String getForegroundColor()
public void setForegroundColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getFormula()
public void setFormula(java.lang.String value)
value
- Value to set property topublic java.lang.String getHelpBookTopic()
public void setHelpBookTopic(java.lang.String value)
value
- Value to set property topublic java.lang.String getHighestAllowedValue()
public void setHighestAllowedValue(java.lang.String value)
value
- Value to set property topublic java.lang.String getHint()
public void setHint(java.lang.String value)
value
- Value to set property topublic java.lang.String getIconFilename()
public void setIconFilename(java.lang.String value)
value
- Value to set property topublic java.lang.String getImplementationClass()
public void setImplementationClass(java.lang.String value)
value
- Value to set property topublic java.lang.String getInitializeValue()
public void setInitializeValue(java.lang.String value)
value
- Value to set property topublic java.lang.String getLabel()
public void setLabel(java.lang.String value)
value
- Value to set property topublic java.lang.String getLovName()
public void setLovName(java.lang.String value)
value
- Value to set property topublic java.lang.String getLowestAllowedValue()
public void setLowestAllowedValue(java.lang.String value)
value
- Value to set property topublic java.lang.String getName()
getName
in class oracle.forms.jdapi.BaseFormsObject
public void setName(java.lang.String value)
value
- Value to set property topublic java.lang.String getNextNavigationItemName()
public void setNextNavigationItemName(java.lang.String value)
value
- Value to set property topublic java.lang.String getOleClass()
public void setOleClass(java.lang.String value)
value
- Value to set property topublic java.lang.String getOtherValues()
public void setOtherValues(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentFilename()
public void setParentFilename(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentFilepath()
public void setParentFilepath(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentModule()
public void setParentModule(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentName()
public void setParentName(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentSourceLevel1ObjectName()
public void setParentSourceLevel1ObjectName(java.lang.String value)
value
- Value to set property topublic java.lang.String getPopupMenuName()
public void setPopupMenuName(java.lang.String value)
value
- Value to set property topublic java.lang.String getPreviousNavigationItemName()
public void setPreviousNavigationItemName(java.lang.String value)
value
- Value to set property topublic java.lang.String getPrompt()
public void setPrompt(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptBackColor()
public void setPromptBackColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptFillPattern()
public void setPromptFillPattern(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptFontName()
public void setPromptFontName(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptForegroundColor()
public void setPromptForegroundColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptVisualAttributeName()
public void setPromptVisualAttributeName(java.lang.String value)
value
- Value to set property topublic java.lang.String getRecordGroupName()
public void setRecordGroupName(java.lang.String value)
value
- Value to set property topublic java.lang.String getRecordVisualAttributeGroupName()
public void setRecordVisualAttributeGroupName(java.lang.String value)
value
- Value to set property topublic java.lang.String getSummaryBlockName()
public void setSummaryBlockName(java.lang.String value)
value
- Value to set property topublic java.lang.String getSummaryItemName()
public void setSummaryItemName(java.lang.String value)
value
- Value to set property topublic java.lang.String getSynchronizedItemName()
public void setSynchronizedItemName(java.lang.String value)
value
- Value to set property topublic java.lang.String getTabPageName()
public void setTabPageName(java.lang.String value)
value
- Value to set property topublic java.lang.String getTooltip()
public void setTooltip(java.lang.String value)
value
- Value to set property topublic java.lang.String getTooltipVisualAttributeGroup()
public void setTooltipVisualAttributeGroup(java.lang.String value)
value
- Value to set property topublic java.lang.String getTreeDataQuery()
public void setTreeDataQuery(java.lang.String value)
value
- Value to set property topublic java.lang.String getTreeRecordGroup()
public void setTreeRecordGroup(java.lang.String value)
value
- Value to set property topublic java.lang.String getUncheckedValue()
public void setUncheckedValue(java.lang.String value)
value
- Value to set property topublic java.lang.String getVisualAttributeName()
public void setVisualAttributeName(java.lang.String value)
value
- Value to set property topublic int getAudioChannels()
public void setAudioChannels(int value)
value
- Value to set property topublic int getBevel()
public void setBevel(int value)
value
- Value to set property topublic int getCalculateMode()
public void setCalculateMode(int value)
value
- Value to set property topublic int getCaseRestriction()
public void setCaseRestriction(int value)
value
- Value to set property topublic int getCheckBoxOtherValues()
public void setCheckBoxOtherValues(int value)
value
- Value to set property topublic int getCompressionQuality()
public void setCompressionQuality(int value)
value
- Value to set property topublic int getCommMode()
public void setCommMode(int value)
value
- Value to set property topublic int getCompress()
public void setCompress(int value)
value
- Value to set property topublic int getDataType()
public void setDataType(int value)
value
- Value to set property topublic int getDataLengthSemantics()
public void setDataLengthSemantics(int value)
value
- Value to set property topublic int getDisplayQuality()
public void setDisplayQuality(int value)
value
- Value to set property topublic int getDistanceBetweenRecords()
public void setDistanceBetweenRecords(int value)
value
- Value to set property topublic int getEditXPosition()
public void setEditXPosition(int value)
value
- Value to set property topublic int getEditYPosition()
public void setEditYPosition(int value)
value
- Value to set property topublic int getExecuteMode()
public void setExecuteMode(int value)
value
- Value to set property topublic int getFontSize()
public void setFontSize(int value)
value
- Value to set property topublic int getFontSpacing()
public void setFontSpacing(int value)
value
- Value to set property topublic int getFontStyle()
public void setFontStyle(int value)
value
- Value to set property topublic int getFontWeight()
public void setFontWeight(int value)
value
- Value to set property topublic int getHeight()
public void setHeight(int value)
value
- Value to set property topublic int getImageDepth()
public void setImageDepth(int value)
value
- Value to set property topublic int getImageFormat()
public void setImageFormat(int value)
value
- Value to set property topublic int getInitializeKeyboardDirection()
public void setInitializeKeyboardDirection(int value)
value
- Value to set property topublic int getItemType()
public void setItemType(int value)
value
- Value to set property topublic int getItemsDisplay()
public void setItemsDisplay(int value)
value
- Value to set property topublic int getJustification()
public void setJustification(int value)
value
- Value to set property topublic int getKeyboardState()
public void setKeyboardState(int value)
value
- Value to set property topublic int getLanguageDirection()
public void setLanguageDirection(int value)
value
- Value to set property topublic int getLovXPosition()
public void setLovXPosition(int value)
value
- Value to set property topublic int getLovYPosition()
public void setLovYPosition(int value)
value
- Value to set property topublic int getListElementCount()
public int getListStyle()
public void setListStyle(int value)
value
- Value to set property topublic int getMaximumLength()
public void setMaximumLength(int value)
value
- Value to set property topublic int getOleActionStyle()
public void setOleActionStyle(int value)
value
- Value to set property topublic int getOlePopupMenuItems()
public void setOlePopupMenuItems(int value)
value
- Value to set property topublic int getOleResizStyle()
public void setOleResizStyle(int value)
value
- Value to set property topublic int getOleTenantTypeAspect()
public void setOleTenantTypeAspect(int value)
value
- Value to set property topublic int getOleTenantTypeType()
public void setOleTenantTypeType(int value)
value
- Value to set property topublic int getParentModuleType()
public void setParentModuleType(int value)
value
- Value to set property topublic int getParentSourceLevel1ObjectType()
public void setParentSourceLevel1ObjectType(int value)
value
- Value to set property topublic int getParentType()
public void setParentType(int value)
value
- Value to set property topublic int getPersistentClientInfoLength()
public void setPersistentClientInfoLength(int value)
value
- Value to set property topublic int getPromptAlign()
public void setPromptAlign(int value)
value
- Value to set property topublic int getPromptAlignOffset()
public void setPromptAlignOffset(int value)
value
- Value to set property topublic int getPromptAttachmentEdge()
public void setPromptAttachmentEdge(int value)
value
- Value to set property topublic int getPromptAttachmentOffset()
public void setPromptAttachmentOffset(int value)
value
- Value to set property topublic int getPromptDisplayStyle()
public void setPromptDisplayStyle(int value)
value
- Value to set property topublic int getPromptFontSize()
public void setPromptFontSize(int value)
value
- Value to set property topublic int getPromptFontSpacing()
public void setPromptFontSpacing(int value)
value
- Value to set property topublic int getPromptFontStyle()
public void setPromptFontStyle(int value)
value
- Value to set property topublic int getPromptFontWeight()
public void setPromptFontWeight(int value)
value
- Value to set property topublic int getPromptJustification()
public void setPromptJustification(int value)
value
- Value to set property topublic int getPromptReadingOrder()
public void setPromptReadingOrder(int value)
value
- Value to set property topublic int getQueryLength()
public void setQueryLength(int value)
value
- Value to set property topublic int getReadingOrder()
public void setReadingOrder(int value)
value
- Value to set property topublic int getSizingStyle()
public void setSizingStyle(int value)
value
- Value to set property topublic int getSoundFormat()
public void setSoundFormat(int value)
value
- Value to set property topublic int getSoundQuality()
public void setSoundQuality(int value)
value
- Value to set property topublic int getSummaryFunction()
public void setSummaryFunction(int value)
value
- Value to set property topublic int getWidth()
public void setWidth(int value)
value
- Value to set property topublic int getWrapStyle()
public void setWrapStyle(int value)
value
- Value to set property topublic int getXPosition()
public void setXPosition(int value)
value
- Value to set property topublic int getYPosition()
public void setYPosition(int value)
value
- Value to set property topublic boolean isAutoHint()
public void setAutoHint(boolean value)
value
- Value to set property topublic boolean isAutoSkip()
public void setAutoSkip(boolean value)
value
- Value to set property topublic boolean isCaseInsensitiveQuery()
public void setCaseInsensitiveQuery(boolean value)
value
- Value to set property topublic boolean isConcealData()
public void setConcealData(boolean value)
value
- Value to set property topublic boolean isDatabaseItem()
public void setDatabaseItem(boolean value)
value
- Value to set property topublic boolean isDefaultButton()
public void setDefaultButton(boolean value)
value
- Value to set property topublic boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property topublic boolean isEnabled()
public void setEnabled(boolean value)
value
- Value to set property topublic boolean isFixedLength()
public void setFixedLength(boolean value)
value
- Value to set property topublic boolean isIconic()
public void setIconic(boolean value)
value
- Value to set property topublic boolean isInsertAllowed()
public void setInsertAllowed(boolean value)
value
- Value to set property topublic boolean isKeyboardNavigable()
public void setKeyboardNavigable(boolean value)
value
- Value to set property topublic boolean isKeepCursorPosition()
public void setKeepCursorPosition(boolean value)
value
- Value to set property topublic boolean isLockRecord()
public void setLockRecord(boolean value)
value
- Value to set property topublic boolean isMultiLine()
public void setMultiLine(boolean value)
value
- Value to set property topublic boolean isMouseNavigate()
public void setMouseNavigate(boolean value)
value
- Value to set property topublic boolean isOleInPlaceAction()
public void setOleInPlaceAction(boolean value)
value
- Value to set property topublic boolean isOleInsideOutSupport()
public void setOleInsideOutSupport(boolean value)
value
- Value to set property topublic boolean isOleShowPopupMenu()
public void setOleShowPopupMenu(boolean value)
value
- Value to set property topublic boolean isOleShowTenantTypeType()
public void setOleShowTenantTypeType(boolean value)
value
- Value to set property topublic boolean isPrimaryKey()
public void setPrimaryKey(boolean value)
value
- Value to set property topublic boolean isQueryAllowed()
public void setQueryAllowed(boolean value)
value
- Value to set property topublic boolean isQueryOnly()
public void setQueryOnly(boolean value)
value
- Value to set property topublic boolean isRendered()
public void setRendered(boolean value)
value
- Value to set property topublic boolean isRequired()
public void setRequired(boolean value)
value
- Value to set property topublic boolean isShowFastForward()
public void setShowFastForward(boolean value)
value
- Value to set property topublic boolean isShowHorizontalScrollbar()
public void setShowHorizontalScrollbar(boolean value)
value
- Value to set property topublic boolean isShowPalette()
public void setShowPalette(boolean value)
value
- Value to set property topublic boolean isShowPlay()
public void setShowPlay(boolean value)
value
- Value to set property topublic boolean isShowRecord()
public void setShowRecord(boolean value)
value
- Value to set property topublic boolean isShowRewind()
public void setShowRewind(boolean value)
value
- Value to set property topublic boolean isShowSlider()
public void setShowSlider(boolean value)
value
- Value to set property topublic boolean isShowTime()
public void setShowTime(boolean value)
value
- Value to set property topublic boolean isShowVerticalScrollbar()
public void setShowVerticalScrollbar(boolean value)
value
- Value to set property topublic boolean isShowVolume()
public void setShowVolume(boolean value)
value
- Value to set property topublic boolean isSubclassSubObject()
public void setSubclassSubObject(boolean value)
value
- Value to set property topublic boolean isTreeAllowEmpBranch()
public void setTreeAllowEmpBranch(boolean value)
value
- Value to set property topublic boolean isTreeMultiSelect()
public void setTreeMultiSelect(boolean value)
value
- Value to set property topublic boolean isTreeShowLines()
public void setTreeShowLines(boolean value)
value
- Value to set property topublic boolean isTreeShowSymbol()
public void setTreeShowSymbol(boolean value)
value
- Value to set property topublic boolean isUpdateAllowed()
public void setUpdateAllowed(boolean value)
value
- Value to set property topublic boolean isUpdateCommit()
public void setUpdateCommit(boolean value)
value
- Value to set property topublic boolean isUpdateIfNull()
public void setUpdateIfNull(boolean value)
value
- Value to set property topublic boolean isUpdateQuery()
public void setUpdateQuery(boolean value)
value
- Value to set property topublic boolean isValidateFromList()
public void setValidateFromList(boolean value)
value
- Value to set property topublic boolean isVisible()
public void setVisible(boolean value)
value
- Value to set property topublic Canvas getCanvasObject()
public void setCanvasObject(Canvas value)
value
- Canvas object to set property topublic Editor getEditObject()
public void setEditObject(Editor value)
value
- Editor object to set property topublic LOV getLovObject()
public void setLovObject(LOV value)
value
- LOV object to set property topublic JdapiObject getModule()
getModule
in class oracle.forms.jdapi.BaseFormsObject
public Item getNextNavigationItemObject()
public void setNextNavigationItemObject(Item value)
value
- Item object to set property topublic JdapiObject getOwner()
getOwner
in class oracle.forms.jdapi.BaseFormsObject
public Menu getPopupMenuObject()
public void setPopupMenuObject(Menu value)
value
- Menu object to set property topublic VisualAttribute getPopupVisualAttributeObject()
public void setPopupVisualAttributeObject(VisualAttribute value)
value
- VisualAttribute object to set property topublic Item getPreviousNavigationItemObject()
public void setPreviousNavigationItemObject(Item value)
value
- Item object to set property topublic VisualAttribute getPromptVisualAttributeObject()
public void setPromptVisualAttributeObject(VisualAttribute value)
value
- VisualAttribute object to set property topublic JdapiIterator getRadioButtons()
public RecordGroup getRecordGroupObject()
public void setRecordGroupObject(RecordGroup value)
value
- RecordGroup object to set property topublic VisualAttribute getRecordVisualAttributeGroupObject()
public void setRecordVisualAttributeGroupObject(VisualAttribute value)
value
- VisualAttribute object to set property topublic JdapiObject getSource()
public Item getSynchronizedItemObject()
public void setSynchronizedItemObject(Item value)
value
- Item object to set property topublic TabPage getTabPageObject()
public void setTabPageObject(TabPage value)
value
- TabPage object to set property topublic JdapiIterator getTriggers()
public VisualAttribute getVisualAttributeObject()
public void setVisualAttributeObject(VisualAttribute value)
value
- VisualAttribute object to set property toprotected long getObjectPointer()
public int queryType()
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.queryType
in interface JdapiObject
JdapiTypes
.public void setClientInfo(java.lang.Object clientInfo)
This client info object is not persistent and will be lost when the session ends.
setClientInfo
in interface JdapiObject
clientInfo
- client info to be associated with the object.public java.lang.Object getClientInfo()
setClientObject
.getClientInfo
in interface JdapiObject
public Blob getPersistentClientInfoBlob()
getPersistentClientInfoBlob
in interface JdapiObject
Blob
containing client info.public java.lang.Object getPersistentClientInfoObject()
getPersistentClientInfoObject
in interface JdapiObject
public void setPersistentClientInfo(Blob val)
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.
setPersistentClientInfo
in interface JdapiObject
val
- a Blob
object containing client info.public void setPersistentClientInfo(java.io.Serializable obj)
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.
setPersistentClientInfo
in interface JdapiObject
val
- any Serializable object containing client info.public boolean equals(JdapiObject obj)
equals
in interface JdapiObject
object
- object to be compared.public JdapiObject clone(JdapiObject parent, java.lang.String newName)
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.
clone
in interface JdapiObject
parent
- owner of the new object.newName
- name of the new object.public void changeOwner(JdapiObject newOwner)
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.
changeOwner
in interface JdapiObject
newOwner
- the new owner of referred object; specify null if you want the object to have no owner.JdapiException
- if newOwner is in a different
module.public java.lang.String toString()
toString
in interface JdapiObject
toString
in class java.lang.Object
protected void clearObjectPointer()
public boolean isValidFormsObject()
JdapiObject
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.
isValidFormsObject
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
public void destroy()
destroy
in interface JdapiObject
public void move(JdapiObject next)
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;
move
in interface JdapiObject
nextObject
- the object next to which the specified object
is to be moved.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.public boolean getBooleanProperty(int propertyTypeId)
getBooleanProperty
in interface JdapiObject
propertyTypeId
- property type ID for which a boolean value is returned.public java.lang.String getStringProperty(int propertyTypeId)
getStringProperty
in interface JdapiObject
propertyTypeId
- property type ID for which a string value is returned.public int getIntegerProperty(int propertyTypeId)
... if(propClass.hasProperty(propNumber) && propClass.allowGet(propNumber)) { int propValue = propClass.getIntegerProperty(propNum); } ...
getIntegerProperty
in interface JdapiObject
propertyTypeId
- property type ID for which an integer value is returned.public int getStringIDProperty(int propertyTypeId)
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.
getStringIDProperty
in interface JdapiObject
propertyTypeId
- property type ID for which a String ID value is returned.public java.lang.String getPropertyValueName(int propertyTypeId, int val)
JdapiObject
getPropertyValueName
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- Property numberval
- Value of propertypublic java.lang.String getIntegerPropertyString(int propertyTypeId)
JdapiObject
long
) property value's text
representation.getIntegerPropertyString
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- Number identifying the propertyprotected long getObjProp(int propertyTypeId)
ContextCache
to lookup/instantiate
the Java representation of the object.propertyTypeId
- Number identifying the propertyoracle.forms.builder.jfapi.ContextCache
,
#getObjectProp
public JdapiObject getObjectProperty(int propertyTypeId)
JdapiObject
getObjectProperty
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- property type ID for which a JdapiObject value is returned.public JdapiIterator getChildObjectProperty(int propertyTypeId)
JdapiObject
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.
getChildObjectProperty
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- number identifying the child object property.public void setBooleanProperty(int propertyTypeId, boolean propertyValue)
JdapiObject
setBooleanProperty
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- property type ID of the property for which you want to set the boolean value.propertyValue
- the boolean value for the property.public void setStringProperty(int propertyTypeId, java.lang.String propertyValue)
JdapiObject
setStringProperty
in interface JdapiObject
oracle.forms.jdapi.JdapiObject
propertyTypeId
- property type ID of the property for which you want to set the string value.propertyValue
- the string value for the property.public void setIntegerProperty(int propertyTypeId, int propertyValue)
setIntegerProperty
in interface JdapiObject
propertyTypeId
- property type id for which we set the integer value.propertyValue
- the integer property value in property.protected void setObjProp(int propertyTypeId, long val)
propertyTypeId
- Number identifying the propertyval
- Value to set the property to#setObjectProp
public void setObjectProperty(int propertyTypeId, JdapiObject propertyValue)
setObjectProperty
in interface JdapiObject
propertyTypeId
- property type id for which we set the object property value.propertyValue
- the object property value in property.public boolean hasProperty(int propertyTypeId)
hasProperty
in interface JdapiObject
propertyTypeId
- Number identifying the propertypublic void inheritProperty(int propertyTypeId)
inheritProperty
in interface JdapiObject
propertyTypeId
- Number that identified the propertypublic boolean hasInheritedProperty(int propertyTypeId)
hasInheritedProperty
in interface JdapiObject
propertyTypeId
- Number that identified the propertypublic boolean hasOverriddenProperty(int propertyTypeId)
hasOverriddenProperty
in interface JdapiObject
propertyTypeId
- The type id of the property to
be queried.public boolean hasDefaultedProperty(int propertyTypeId)
hasDefaultedProperty
in interface JdapiObject
propertyTypeId
- Number that identified the propertypublic int getPropertyState(int propertyTypeId)
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;
getPropertyState
in interface JdapiObject
propertyTypeId
- The type id of the property.public boolean isSubclassed()
isSubclassed
in interface JdapiObject
public JdapiObject getSubclassParent()
getSubclassParent
in interface JdapiObject
public void setSubclassParent(JdapiObject parent)
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.
setSubclassParent
in interface JdapiObject
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.public JdapiObject createSubclassedChild(JdapiObject childOwner, java.lang.String childName)
createSubclassedChild
in interface JdapiObject
childOwner
- The object that will own
the newly created subclassed child object.childName
- The name to be given to the newly
created child.public void reattach()
reattach
in interface JdapiObject
public JdapiIterator getOwnedObjects()
getOwnedObjects
in interface JdapiObject
public java.lang.String getClassName()
getClassName
in interface JdapiObject
public java.lang.String getQualifiedName(boolean includeModule)
getQualifiedName
in interface JdapiObject
includeModule
- Include the module namepublic JdapiMetaObject getJdapiMetaObject()
getJdapiMetaObject
in interface JdapiObject
public JdapiIterator getMetaProperties()
The various property type ids and the object-property mapping are defined by the specific implementation in the respective Constants file.
getMetaProperties
in interface JdapiObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |