oracle.forms.jdapi
Class Block

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

public class Block
extends oracle.forms.jdapi.BaseFormsObject

Object to represent a Forms Block object. This is an encapsulation of the Forms C API d2fblk.

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
  Block(FormModule parent, java.lang.String name)
          Constructor used to create Block objects in the context of a FormModule parent object.
  Block(FormModule parent, java.lang.String name, Block base)
          Constructor used to create Block objects in the context of a FormModule parent object.
  Block(FormModule parent, java.lang.String name, PropertyClass base)
          Constructor used to create Block objects in the context of a FormModule parent object.
protected Block(long pd2fblk)
          Protected constructor, used internally to create Block objects.
  Block(ObjectGroup parent, java.lang.String name)
          Constructor used to create Block objects in the context of a ObjectGroup parent object.
  Block(ObjectGroup parent, java.lang.String name, Block base)
          Constructor used to create Block objects in the context of a ObjectGroup parent object.
  Block(ObjectGroup parent, java.lang.String name, PropertyClass base)
          Constructor used to create Block objects in the context of a ObjectGroup parent object.
  Block(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name)
          Constructor used to create Block objects in the context of an ObjectLibraryTab parent object.
  Block(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, Block base)
          Constructor used to create Block objects in the context of an ObjectLibraryTab parent object.
  Block(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, PropertyClass base)
          Constructor used to create Block 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.
 Block clone(FormModule 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.
 Block clone(ObjectGroup parent, java.lang.String newName)
          Creates a copy of the object as a child of 'parent'
 Block 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 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 Block find(FormModule parent, java.lang.String name)
          Find an instance of Block that is a child of a FormModule.
static Block find(ObjectGroup parent, java.lang.String name)
          Find an instance of Block that is a child of a ObjectGroup.
static Block find(ObjectLibraryTab parent, java.lang.String name)
          Find an instance of Block that is a child of a ObjectLibraryTab.
 java.lang.String getAlias()
          Get text property Alias (ALIAS_PTID).
 java.lang.String getBackColor()
          Get text property BackColor (BACK_COLOR_PTID).
 boolean getBooleanProperty(int propertyTypeId)
          Retrieves a boolean property from the referred object.
 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 getComment()
          Get text property Comment (COMMENT_PTID).
 JdapiIterator getDeleteDataSourceArguments()
          Accessor for child DeleteDataSourceArgument objects (DELETE_DATA_SOURCE_ARGUMENT_PTID).
 JdapiIterator getDeleteDataSourceColumns()
          Accessor for child DeleteDataSourceColumn objects (DELETE_DATA_SOURCE_COLUMN_PTID).
 java.lang.String getDeleteProcedureName()
          Get text property DeleteProcedureName (DELETE_PROCEDURE_NAME_PTID).
 int getDMLArraySize()
          Get number property DMLArraySize (DML_ARRAY_SIZE_PTID).
 java.lang.String getDMLDataName()
          Get text property DMLDataName (DML_DATA_NAME_PTID).
 int getDMLDataType()
          Get number property DMLDataType (DML_DATA_TYPE_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).
 JdapiIterator getInsertDataSourceArguments()
          Accessor for child InsertDataSourceArgument objects (INSERT_DATA_SOURCE_ARGUMENT_PTID).
 JdapiIterator getInsertDataSourceColumns()
          Accessor for child InsertDataSourceColumn objects (INSERT_DATA_SOURCE_COLUMN_PTID).
 java.lang.String getInsertProcedureName()
          Get text property InsertProcedureName (INSERT_PROCEDURE_NAME_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.
 JdapiIterator getItems()
          Accessor for child Item objects (ITEM_PTID).
 JdapiMetaObject getJdapiMetaObject()
          Gets the metadata object for the specified object.
 int getKeyMode()
          Get number property KeyMode (KEY_MODE_PTID).
 int getLanguageDirection()
          Get number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
 JdapiIterator getLockDataSourceArguments()
          Accessor for child LockDataSourceArgument objects (LOCK_DATA_SOURCE_ARGUMENT_PTID).
 JdapiIterator getLockDataSourceColumns()
          Accessor for child LockDataSourceColumn objects (LOCK_DATA_SOURCE_COLUMN_PTID).
 int getLockMode()
          Get number property LockMode (LOCK_MODE_PTID).
 java.lang.String getLockProcedureName()
          Get text property LockProcedureName (LOCK_PROCEDURE_NAME_PTID).
 int getMaximumQueryTime()
          Get number property MaximumQueryTime (MAXIMUM_QUERY_TIME_PTID).
 int getMaximumRecordsFetched()
          Get number property MaximumRecordsFetched (MAXIMUM_RECORDS_FETCHED_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).
 int getNavigationStyle()
          Get number property NavigationStyle (NAVIGATION_STYLE_PTID).
 java.lang.String getNextNavigationBlockName()
          Get text property NextNavigationBlockName (NEXT_NAVIGATION_BLOCK_NAME_PTID).
 Block getNextNavigationBlockObject()
          Get object property NextNavigationBlockObject (NEXT_NAVIGATION_BLOCK_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.
 java.lang.String getOptionHint()
          Get text property OptionHint (OPTION_HINT_PTID).
 java.lang.String getOrderByClause()
          Get text property OrderByClause (ORDER_BY_CLAUSE_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).
 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 getPreviousNavigationBlockName()
          Get text property PreviousNavigationBlockName (PREVIOUS_NAVIGATION_BLOCK_NAME_PTID).
 Block getPreviousNavigationBlockObject()
          Get object property PreviousNavigationBlockObject (PREVIOUS_NAVIGATION_BLOCK_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...
 JdapiIterator getQueryDataSourceArguments()
          Accessor for child QueryDataSourceArgument objects (QUERY_DATA_SOURCE_ARGUMENT_PTID).
 JdapiIterator getQueryDataSourceColumns()
          Accessor for child QueryDataSourceColumn objects (QUERY_DATA_SOURCE_COLUMN_PTID).
 java.lang.String getQueryDataSourceName()
          Get text property QueryDataSourceName (QUERY_DATA_SOURCE_NAME_PTID).
 int getQueryDataSourceType()
          Get number property QueryDataSourceType (QUERY_DATA_SOURCE_TYPE_PTID).
 int getRecordOrientation()
          Get number property RecordOrientation (RECORD_ORIENTATION_PTID).
 int getRecordsBufferedCount()
          Get number property RecordsBufferedCount (RECORDS_BUFFERED_COUNT_PTID).
 int getRecordsDisplayCount()
          Get number property RecordsDisplayCount (RECORDS_DISPLAY_COUNT_PTID).
 int getRecordsFetchedCount()
          Get number property RecordsFetchedCount (RECORDS_FETCHED_COUNT_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).
 JdapiIterator getRelations()
          Accessor for child Relation objects (RELATION_PTID).
 java.lang.String getScrollbarCanvasName()
          Get text property ScrollbarCanvasName (SCROLLBAR_CANVAS_NAME_PTID).
 Canvas getScrollbarCanvasObject()
          Get object property ScrollbarCanvasObject (SCROLLBAR_CANVAS_OBJECT_PTID).
 int getScrollbarLength()
          Get number property ScrollbarLength (SCROLLBAR_LENGTH_PTID).
 int getScrollbarOrientation()
          Get number property ScrollbarOrientation (SCROLLBAR_ORIENTATION_PTID).
 java.lang.String getScrollbarTabPageName()
          Get text property ScrollbarTabPageName (SCROLLBAR_TABPAGE_NAME_PTID).
 TabPage getScrollbarTabPageObject()
          Get object property ScrollbarTabPageObject (SCROLLBAR_TABPAGE_OBJECT_PTID).
 int getScrollbarWidth()
          Get number property ScrollbarWidth (SCROLLBAR_WIDTH_PTID).
 int getScrollbarXPosition()
          Get number property ScrollbarXPosition (SCROLLBAR_X_POSITION_PTID).
 int getScrollbarYPosition()
          Get number property ScrollbarYPosition (SCROLLBAR_Y_POSITION_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.
 JdapiIterator getTriggers()
          Accessor for child Trigger objects (TRIGGER_PTID).
 int getTypeId()
          Gets the HtmlForms object type ID.
 JdapiIterator getUpdateDataSourceArguments()
          Accessor for child UpdateDataSourceArgument objects (UPDATE_DATA_SOURCE_ARGUMENT_PTID).
 JdapiIterator getUpdateDataSourceColumns()
          Accessor for child UpdateDataSourceColumn objects (UPDATE_DATA_SOURCE_COLUMN_PTID).
 java.lang.String getUpdateProcedureName()
          Get text property UpdateProcedureName (UPDATE_PROCEDURE_NAME_PTID).
 java.lang.String getVisualAttributeName()
          Get text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).
 VisualAttribute getVisualAttributeObject()
          Get object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).
 java.lang.String getWhereClause()
          Get text property WhereClause (WHERE_CLAUSE_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?).
 boolean isDatabaseBlock()
          Get boolean property DatabaseBlock (DATABASE_BLOCK_PTID).
 boolean isDeleteAllowed()
          Get boolean property DeleteAllowed (DELETE_ALLOWED_PTID).
 boolean isDirtyInfo()
          Get boolean property DirtyInfo (DIRTY_INFO_PTID).
 boolean isDMLReturnValue()
          Get boolean property DMLReturnValue (DML_RETURN_VALUE_PTID).
 boolean isEnforcedColumnSecurity()
          Get boolean property EnforcedColumnSecurity (ENFORCED_COLUMN_SECURITY_PTID).
 boolean isEnforcedPrimaryKey()
          Get boolean property EnforcedPrimaryKey (ENFORCED_PRIMARY_KEY_PTID).
 boolean isIncludeRefitem()
          Get boolean property IncludeRefitem (INCLUDE_REFITEM_PTID).
 boolean isInsertAllowed()
          Get boolean property InsertAllowed (INSERT_ALLOWED_PTID).
 boolean isPrecompSummary()
          Get boolean property PrecompSummary (PRECOMP_SUMMARY_PTID).
 boolean isQueryAllowed()
          Get boolean property QueryAllowed (QUERY_ALLOWED_PTID).
 boolean isQueryAllRecords()
          Get boolean property QueryAllRecords (QUERY_ALL_RECORDS_PTID).
 boolean isReverseDirection()
          Get boolean property ReverseDirection (REVERSE_DIRECTION_PTID).
 boolean isShowScrollbar()
          Get boolean property ShowScrollbar (SHOW_SCROLLBAR_PTID).
 boolean isSingleRecord()
          Get boolean property SingleRecord (SINGLE_RECORD_PTID).
 boolean isSubclassed()
          Checks if the object is subclassed from another object.
 boolean isSubclassObjectGroup()
          Get boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).
 boolean isUpdateAllowed()
          Get boolean property UpdateAllowed (UPDATE_ALLOWED_PTID).
 boolean isUpdateChangedColumns()
          Get boolean property UpdateChangedColumns (UPDATE_CHANGED_COLUMNS_PTID).
 boolean isValidFormsObject()
          Determines whether this Java instance references a valid Forms object.
 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 setAlias(java.lang.String value)
          Sets text property Alias (ALIAS_PTID).
 void setBackColor(java.lang.String value)
          Sets text property BackColor (BACK_COLOR_PTID).
 void setBooleanProperty(int propertyTypeId, boolean propertyValue)
          Sets the value of the specified boolean property belonging to the referred object.
 void setClientInfo(java.lang.Object clientInfo)
          Sets the client information.
 void setComment(java.lang.String value)
          Sets text property Comment (COMMENT_PTID).
 void setDatabaseBlock(boolean value)
          Sets boolean property DatabaseBlock (DATABASE_BLOCK_PTID).
 void setDeleteAllowed(boolean value)
          Sets boolean property DeleteAllowed (DELETE_ALLOWED_PTID).
 void setDeleteProcedureName(java.lang.String value)
          Sets text property DeleteProcedureName (DELETE_PROCEDURE_NAME_PTID).
 void setDirtyInfo(boolean value)
          Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
 void setDMLArraySize(int value)
          Sets number property DMLArraySize (DML_ARRAY_SIZE_PTID).
 void setDMLDataName(java.lang.String value)
          Sets text property DMLDataName (DML_DATA_NAME_PTID).
 void setDMLDataType(int value)
          Sets number property DMLDataType (DML_DATA_TYPE_PTID).
 void setDMLReturnValue(boolean value)
          Sets boolean property DMLReturnValue (DML_RETURN_VALUE_PTID).
 void setEnforcedColumnSecurity(boolean value)
          Sets boolean property EnforcedColumnSecurity (ENFORCED_COLUMN_SECURITY_PTID).
 void setEnforcedPrimaryKey(boolean value)
          Sets boolean property EnforcedPrimaryKey (ENFORCED_PRIMARY_KEY_PTID).
 void setFillPattern(java.lang.String value)
          Sets text property FillPattern (FILL_PATTERN_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 setIncludeRefitem(boolean value)
          Sets boolean property IncludeRefitem (INCLUDE_REFITEM_PTID).
 void setInsertAllowed(boolean value)
          Sets boolean property InsertAllowed (INSERT_ALLOWED_PTID).
 void setInsertProcedureName(java.lang.String value)
          Sets text property InsertProcedureName (INSERT_PROCEDURE_NAME_PTID).
 void setIntegerProperty(int propertyTypeId, int propertyValue)
          Sets the value of the specified object integer property.
 void setKeyMode(int value)
          Sets number property KeyMode (KEY_MODE_PTID).
 void setLanguageDirection(int value)
          Sets number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
 void setLockMode(int value)
          Sets number property LockMode (LOCK_MODE_PTID).
 void setLockProcedureName(java.lang.String value)
          Sets text property LockProcedureName (LOCK_PROCEDURE_NAME_PTID).
 void setMaximumQueryTime(int value)
          Sets number property MaximumQueryTime (MAXIMUM_QUERY_TIME_PTID).
 void setMaximumRecordsFetched(int value)
          Sets number property MaximumRecordsFetched (MAXIMUM_RECORDS_FETCHED_PTID).
 void setName(java.lang.String value)
          Sets text property Name (NAME_PTID).
 void setNavigationStyle(int value)
          Sets number property NavigationStyle (NAVIGATION_STYLE_PTID).
 void setNextNavigationBlockName(java.lang.String value)
          Sets text property NextNavigationBlockName (NEXT_NAVIGATION_BLOCK_NAME_PTID).
 void setNextNavigationBlockObject(Block value)
          Set object property NextNavigationBlockObject (NEXT_NAVIGATION_BLOCK_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 setOptionHint(java.lang.String value)
          Sets text property OptionHint (OPTION_HINT_PTID).
 void setOrderByClause(java.lang.String value)
          Sets text property OrderByClause (ORDER_BY_CLAUSE_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 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 setPrecompSummary(boolean value)
          Sets boolean property PrecompSummary (PRECOMP_SUMMARY_PTID).
 void setPreviousNavigationBlockName(java.lang.String value)
          Sets text property PreviousNavigationBlockName (PREVIOUS_NAVIGATION_BLOCK_NAME_PTID).
 void setPreviousNavigationBlockObject(Block value)
          Set object property PreviousNavigationBlockObject (PREVIOUS_NAVIGATION_BLOCK_OBJECT_PTID).
 void setQueryAllowed(boolean value)
          Sets boolean property QueryAllowed (QUERY_ALLOWED_PTID).
 void setQueryAllRecords(boolean value)
          Sets boolean property QueryAllRecords (QUERY_ALL_RECORDS_PTID).
 void setQueryDataSourceName(java.lang.String value)
          Sets text property QueryDataSourceName (QUERY_DATA_SOURCE_NAME_PTID).
 void setQueryDataSourceType(int value)
          Sets number property QueryDataSourceType (QUERY_DATA_SOURCE_TYPE_PTID).
 void setRecordOrientation(int value)
          Sets number property RecordOrientation (RECORD_ORIENTATION_PTID).
 void setRecordsBufferedCount(int value)
          Sets number property RecordsBufferedCount (RECORDS_BUFFERED_COUNT_PTID).
 void setRecordsDisplayCount(int value)
          Sets number property RecordsDisplayCount (RECORDS_DISPLAY_COUNT_PTID).
 void setRecordsFetchedCount(int value)
          Sets number property RecordsFetchedCount (RECORDS_FETCHED_COUNT_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 setReverseDirection(boolean value)
          Sets boolean property ReverseDirection (REVERSE_DIRECTION_PTID).
 void setScrollbarCanvasName(java.lang.String value)
          Sets text property ScrollbarCanvasName (SCROLLBAR_CANVAS_NAME_PTID).
 void setScrollbarCanvasObject(Canvas value)
          Set object property ScrollbarCanvasObject (SCROLLBAR_CANVAS_OBJECT_PTID).
 void setScrollbarLength(int value)
          Sets number property ScrollbarLength (SCROLLBAR_LENGTH_PTID).
 void setScrollbarOrientation(int value)
          Sets number property ScrollbarOrientation (SCROLLBAR_ORIENTATION_PTID).
 void setScrollbarTabPageName(java.lang.String value)
          Sets text property ScrollbarTabPageName (SCROLLBAR_TABPAGE_NAME_PTID).
 void setScrollbarTabPageObject(TabPage value)
          Set object property ScrollbarTabPageObject (SCROLLBAR_TABPAGE_OBJECT_PTID).
 void setScrollbarWidth(int value)
          Sets number property ScrollbarWidth (SCROLLBAR_WIDTH_PTID).
 void setScrollbarXPosition(int value)
          Sets number property ScrollbarXPosition (SCROLLBAR_X_POSITION_PTID).
 void setScrollbarYPosition(int value)
          Sets number property ScrollbarYPosition (SCROLLBAR_Y_POSITION_PTID).
 void setShowScrollbar(boolean value)
          Sets boolean property ShowScrollbar (SHOW_SCROLLBAR_PTID).
 void setSingleRecord(boolean value)
          Sets boolean property SingleRecord (SINGLE_RECORD_PTID).
 void setStringProperty(int propertyTypeId, java.lang.String propertyValue)
          Sets the value of the specified string property for the object.
 void setSubclassObjectGroup(boolean value)
          Sets boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).
 void setSubclassParent(JdapiObject parent)
          Change the subclassing parent of the object referred.
 void setUpdateAllowed(boolean value)
          Sets boolean property UpdateAllowed (UPDATE_ALLOWED_PTID).
 void setUpdateChangedColumns(boolean value)
          Sets boolean property UpdateChangedColumns (UPDATE_CHANGED_COLUMNS_PTID).
 void setUpdateProcedureName(java.lang.String value)
          Sets text property UpdateProcedureName (UPDATE_PROCEDURE_NAME_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 setWhereClause(java.lang.String value)
          Sets text property WhereClause (WHERE_CLAUSE_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

Block

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

Block

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

Block

public Block(FormModule parent,
             java.lang.String name,
             PropertyClass base)
Constructor used to create Block objects in the context of a FormModule 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

Block

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

Block

public Block(ObjectGroup parent,
             java.lang.String name,
             Block base)
Constructor used to create Block 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 - Block object to derive from

Block

public Block(ObjectGroup parent,
             java.lang.String name,
             PropertyClass base)
Constructor used to create Block 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

Block

public Block(ObjectLibrary olb,
             ObjectLibraryTab tab,
             java.lang.String name)
Constructor used to create Block 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

Block

public Block(ObjectLibrary olb,
             ObjectLibraryTab tab,
             java.lang.String name,
             Block base)
Constructor used to create Block 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 - Block object to derive from

Block

public Block(ObjectLibrary olb,
             ObjectLibraryTab tab,
             java.lang.String name,
             PropertyClass base)
Constructor used to create Block 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

Block

protected Block(long pd2fblk)
Protected constructor, used internally to create Block objects. This doesn't actually create a new Block, 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
pd2fblk - 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 Block clone(FormModule 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 Block 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 Block 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 Block find(FormModule parent,
                         java.lang.String name)
Find an instance of Block that is a child of a FormModule.
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 Block find(ObjectGroup parent,
                         java.lang.String name)
Find an instance of Block 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 Block find(ObjectLibraryTab parent,
                         java.lang.String name)
Find an instance of Block 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

getAlias

public java.lang.String getAlias()
Get text property Alias (ALIAS_PTID).
Returns:
Value of property

setAlias

public void setAlias(java.lang.String value)
Sets text property Alias (ALIAS_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

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

getDeleteProcedureName

public java.lang.String getDeleteProcedureName()
Get text property DeleteProcedureName (DELETE_PROCEDURE_NAME_PTID).
Returns:
Value of property

setDeleteProcedureName

public void setDeleteProcedureName(java.lang.String value)
Sets text property DeleteProcedureName (DELETE_PROCEDURE_NAME_PTID).
Parameters:
value - Value to set property to

getDMLDataName

public java.lang.String getDMLDataName()
Get text property DMLDataName (DML_DATA_NAME_PTID).
Returns:
Value of property

setDMLDataName

public void setDMLDataName(java.lang.String value)
Sets text property DMLDataName (DML_DATA_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

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

getInsertProcedureName

public java.lang.String getInsertProcedureName()
Get text property InsertProcedureName (INSERT_PROCEDURE_NAME_PTID).
Returns:
Value of property

setInsertProcedureName

public void setInsertProcedureName(java.lang.String value)
Sets text property InsertProcedureName (INSERT_PROCEDURE_NAME_PTID).
Parameters:
value - Value to set property to

getLockProcedureName

public java.lang.String getLockProcedureName()
Get text property LockProcedureName (LOCK_PROCEDURE_NAME_PTID).
Returns:
Value of property

setLockProcedureName

public void setLockProcedureName(java.lang.String value)
Sets text property LockProcedureName (LOCK_PROCEDURE_NAME_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

getNextNavigationBlockName

public java.lang.String getNextNavigationBlockName()
Get text property NextNavigationBlockName (NEXT_NAVIGATION_BLOCK_NAME_PTID).
Returns:
Value of property

setNextNavigationBlockName

public void setNextNavigationBlockName(java.lang.String value)
Sets text property NextNavigationBlockName (NEXT_NAVIGATION_BLOCK_NAME_PTID).
Parameters:
value - Value to set property to

getOptionHint

public java.lang.String getOptionHint()
Get text property OptionHint (OPTION_HINT_PTID).
Returns:
Value of property

setOptionHint

public void setOptionHint(java.lang.String value)
Sets text property OptionHint (OPTION_HINT_PTID).
Parameters:
value - Value to set property to

getOrderByClause

public java.lang.String getOrderByClause()
Get text property OrderByClause (ORDER_BY_CLAUSE_PTID).
Returns:
Value of property

setOrderByClause

public void setOrderByClause(java.lang.String value)
Sets text property OrderByClause (ORDER_BY_CLAUSE_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

getPreviousNavigationBlockName

public java.lang.String getPreviousNavigationBlockName()
Get text property PreviousNavigationBlockName (PREVIOUS_NAVIGATION_BLOCK_NAME_PTID).
Returns:
Value of property

setPreviousNavigationBlockName

public void setPreviousNavigationBlockName(java.lang.String value)
Sets text property PreviousNavigationBlockName (PREVIOUS_NAVIGATION_BLOCK_NAME_PTID).
Parameters:
value - Value to set property to

getQueryDataSourceName

public java.lang.String getQueryDataSourceName()
Get text property QueryDataSourceName (QUERY_DATA_SOURCE_NAME_PTID).
Returns:
Value of property

setQueryDataSourceName

public void setQueryDataSourceName(java.lang.String value)
Sets text property QueryDataSourceName (QUERY_DATA_SOURCE_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

getScrollbarCanvasName

public java.lang.String getScrollbarCanvasName()
Get text property ScrollbarCanvasName (SCROLLBAR_CANVAS_NAME_PTID).
Returns:
Value of property

setScrollbarCanvasName

public void setScrollbarCanvasName(java.lang.String value)
Sets text property ScrollbarCanvasName (SCROLLBAR_CANVAS_NAME_PTID).
Parameters:
value - Value to set property to

getScrollbarTabPageName

public java.lang.String getScrollbarTabPageName()
Get text property ScrollbarTabPageName (SCROLLBAR_TABPAGE_NAME_PTID).
Returns:
Value of property

setScrollbarTabPageName

public void setScrollbarTabPageName(java.lang.String value)
Sets text property ScrollbarTabPageName (SCROLLBAR_TABPAGE_NAME_PTID).
Parameters:
value - Value to set property to

getUpdateProcedureName

public java.lang.String getUpdateProcedureName()
Get text property UpdateProcedureName (UPDATE_PROCEDURE_NAME_PTID).
Returns:
Value of property

setUpdateProcedureName

public void setUpdateProcedureName(java.lang.String value)
Sets text property UpdateProcedureName (UPDATE_PROCEDURE_NAME_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

getWhereClause

public java.lang.String getWhereClause()
Get text property WhereClause (WHERE_CLAUSE_PTID).
Returns:
Value of property

setWhereClause

public void setWhereClause(java.lang.String value)
Sets text property WhereClause (WHERE_CLAUSE_PTID).
Parameters:
value - Value to set property to

getDMLArraySize

public int getDMLArraySize()
Get number property DMLArraySize (DML_ARRAY_SIZE_PTID).
Returns:
Value of property

setDMLArraySize

public void setDMLArraySize(int value)
Sets number property DMLArraySize (DML_ARRAY_SIZE_PTID).
Parameters:
value - Value to set property to

getDMLDataType

public int getDMLDataType()
Get number property DMLDataType (DML_DATA_TYPE_PTID).
Returns:
Value of property

setDMLDataType

public void setDMLDataType(int value)
Sets number property DMLDataType (DML_DATA_TYPE_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

getKeyMode

public int getKeyMode()
Get number property KeyMode (KEY_MODE_PTID).
Returns:
Value of property

setKeyMode

public void setKeyMode(int value)
Sets number property KeyMode (KEY_MODE_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

getLockMode

public int getLockMode()
Get number property LockMode (LOCK_MODE_PTID).
Returns:
Value of property

setLockMode

public void setLockMode(int value)
Sets number property LockMode (LOCK_MODE_PTID).
Parameters:
value - Value to set property to

getMaximumQueryTime

public int getMaximumQueryTime()
Get number property MaximumQueryTime (MAXIMUM_QUERY_TIME_PTID).
Returns:
Value of property

setMaximumQueryTime

public void setMaximumQueryTime(int value)
Sets number property MaximumQueryTime (MAXIMUM_QUERY_TIME_PTID).
Parameters:
value - Value to set property to

getMaximumRecordsFetched

public int getMaximumRecordsFetched()
Get number property MaximumRecordsFetched (MAXIMUM_RECORDS_FETCHED_PTID).
Returns:
Value of property

setMaximumRecordsFetched

public void setMaximumRecordsFetched(int value)
Sets number property MaximumRecordsFetched (MAXIMUM_RECORDS_FETCHED_PTID).
Parameters:
value - Value to set property to

getNavigationStyle

public int getNavigationStyle()
Get number property NavigationStyle (NAVIGATION_STYLE_PTID).
Returns:
Value of property

setNavigationStyle

public void setNavigationStyle(int value)
Sets number property NavigationStyle (NAVIGATION_STYLE_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

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

getQueryDataSourceType

public int getQueryDataSourceType()
Get number property QueryDataSourceType (QUERY_DATA_SOURCE_TYPE_PTID).
Returns:
Value of property

setQueryDataSourceType

public void setQueryDataSourceType(int value)
Sets number property QueryDataSourceType (QUERY_DATA_SOURCE_TYPE_PTID).
Parameters:
value - Value to set property to

getRecordOrientation

public int getRecordOrientation()
Get number property RecordOrientation (RECORD_ORIENTATION_PTID).
Returns:
Value of property

setRecordOrientation

public void setRecordOrientation(int value)
Sets number property RecordOrientation (RECORD_ORIENTATION_PTID).
Parameters:
value - Value to set property to

getRecordsBufferedCount

public int getRecordsBufferedCount()
Get number property RecordsBufferedCount (RECORDS_BUFFERED_COUNT_PTID).
Returns:
Value of property

setRecordsBufferedCount

public void setRecordsBufferedCount(int value)
Sets number property RecordsBufferedCount (RECORDS_BUFFERED_COUNT_PTID).
Parameters:
value - Value to set property to

getRecordsDisplayCount

public int getRecordsDisplayCount()
Get number property RecordsDisplayCount (RECORDS_DISPLAY_COUNT_PTID).
Returns:
Value of property

setRecordsDisplayCount

public void setRecordsDisplayCount(int value)
Sets number property RecordsDisplayCount (RECORDS_DISPLAY_COUNT_PTID).
Parameters:
value - Value to set property to

getRecordsFetchedCount

public int getRecordsFetchedCount()
Get number property RecordsFetchedCount (RECORDS_FETCHED_COUNT_PTID).
Returns:
Value of property

setRecordsFetchedCount

public void setRecordsFetchedCount(int value)
Sets number property RecordsFetchedCount (RECORDS_FETCHED_COUNT_PTID).
Parameters:
value - Value to set property to

getScrollbarLength

public int getScrollbarLength()
Get number property ScrollbarLength (SCROLLBAR_LENGTH_PTID).
Returns:
Value of property

setScrollbarLength

public void setScrollbarLength(int value)
Sets number property ScrollbarLength (SCROLLBAR_LENGTH_PTID).
Parameters:
value - Value to set property to

getScrollbarOrientation

public int getScrollbarOrientation()
Get number property ScrollbarOrientation (SCROLLBAR_ORIENTATION_PTID).
Returns:
Value of property

setScrollbarOrientation

public void setScrollbarOrientation(int value)
Sets number property ScrollbarOrientation (SCROLLBAR_ORIENTATION_PTID).
Parameters:
value - Value to set property to

getScrollbarWidth

public int getScrollbarWidth()
Get number property ScrollbarWidth (SCROLLBAR_WIDTH_PTID).
Returns:
Value of property

setScrollbarWidth

public void setScrollbarWidth(int value)
Sets number property ScrollbarWidth (SCROLLBAR_WIDTH_PTID).
Parameters:
value - Value to set property to

getScrollbarXPosition

public int getScrollbarXPosition()
Get number property ScrollbarXPosition (SCROLLBAR_X_POSITION_PTID).
Returns:
Value of property

setScrollbarXPosition

public void setScrollbarXPosition(int value)
Sets number property ScrollbarXPosition (SCROLLBAR_X_POSITION_PTID).
Parameters:
value - Value to set property to

getScrollbarYPosition

public int getScrollbarYPosition()
Get number property ScrollbarYPosition (SCROLLBAR_Y_POSITION_PTID).
Returns:
Value of property

setScrollbarYPosition

public void setScrollbarYPosition(int value)
Sets number property ScrollbarYPosition (SCROLLBAR_Y_POSITION_PTID).
Parameters:
value - Value to set property to

isDatabaseBlock

public boolean isDatabaseBlock()
Get boolean property DatabaseBlock (DATABASE_BLOCK_PTID).
Returns:
Value of property

setDatabaseBlock

public void setDatabaseBlock(boolean value)
Sets boolean property DatabaseBlock (DATABASE_BLOCK_PTID).
Parameters:
value - Value to set property to

isDeleteAllowed

public boolean isDeleteAllowed()
Get boolean property DeleteAllowed (DELETE_ALLOWED_PTID).
Returns:
Value of property

setDeleteAllowed

public void setDeleteAllowed(boolean value)
Sets boolean property DeleteAllowed (DELETE_ALLOWED_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

isDMLReturnValue

public boolean isDMLReturnValue()
Get boolean property DMLReturnValue (DML_RETURN_VALUE_PTID).
Returns:
Value of property

setDMLReturnValue

public void setDMLReturnValue(boolean value)
Sets boolean property DMLReturnValue (DML_RETURN_VALUE_PTID).
Parameters:
value - Value to set property to

isEnforcedColumnSecurity

public boolean isEnforcedColumnSecurity()
Get boolean property EnforcedColumnSecurity (ENFORCED_COLUMN_SECURITY_PTID).
Returns:
Value of property

setEnforcedColumnSecurity

public void setEnforcedColumnSecurity(boolean value)
Sets boolean property EnforcedColumnSecurity (ENFORCED_COLUMN_SECURITY_PTID).
Parameters:
value - Value to set property to

isEnforcedPrimaryKey

public boolean isEnforcedPrimaryKey()
Get boolean property EnforcedPrimaryKey (ENFORCED_PRIMARY_KEY_PTID).
Returns:
Value of property

setEnforcedPrimaryKey

public void setEnforcedPrimaryKey(boolean value)
Sets boolean property EnforcedPrimaryKey (ENFORCED_PRIMARY_KEY_PTID).
Parameters:
value - Value to set property to

isIncludeRefitem

public boolean isIncludeRefitem()
Get boolean property IncludeRefitem (INCLUDE_REFITEM_PTID).
Returns:
Value of property

setIncludeRefitem

public void setIncludeRefitem(boolean value)
Sets boolean property IncludeRefitem (INCLUDE_REFITEM_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

isPrecompSummary

public boolean isPrecompSummary()
Get boolean property PrecompSummary (PRECOMP_SUMMARY_PTID).
Returns:
Value of property

setPrecompSummary

public void setPrecompSummary(boolean value)
Sets boolean property PrecompSummary (PRECOMP_SUMMARY_PTID).
Parameters:
value - Value to set property to

isQueryAllRecords

public boolean isQueryAllRecords()
Get boolean property QueryAllRecords (QUERY_ALL_RECORDS_PTID).
Returns:
Value of property

setQueryAllRecords

public void setQueryAllRecords(boolean value)
Sets boolean property QueryAllRecords (QUERY_ALL_RECORDS_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

isReverseDirection

public boolean isReverseDirection()
Get boolean property ReverseDirection (REVERSE_DIRECTION_PTID).
Returns:
Value of property

setReverseDirection

public void setReverseDirection(boolean value)
Sets boolean property ReverseDirection (REVERSE_DIRECTION_PTID).
Parameters:
value - Value to set property to

isShowScrollbar

public boolean isShowScrollbar()
Get boolean property ShowScrollbar (SHOW_SCROLLBAR_PTID).
Returns:
Value of property

setShowScrollbar

public void setShowScrollbar(boolean value)
Sets boolean property ShowScrollbar (SHOW_SCROLLBAR_PTID).
Parameters:
value - Value to set property to

isSingleRecord

public boolean isSingleRecord()
Get boolean property SingleRecord (SINGLE_RECORD_PTID).
Returns:
Value of property

setSingleRecord

public void setSingleRecord(boolean value)
Sets boolean property SingleRecord (SINGLE_RECORD_PTID).
Parameters:
value - Value to set property to

isSubclassObjectGroup

public boolean isSubclassObjectGroup()
Get boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).
Returns:
Value of property

setSubclassObjectGroup

public void setSubclassObjectGroup(boolean value)
Sets boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_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

isUpdateChangedColumns

public boolean isUpdateChangedColumns()
Get boolean property UpdateChangedColumns (UPDATE_CHANGED_COLUMNS_PTID).
Returns:
Value of property

setUpdateChangedColumns

public void setUpdateChangedColumns(boolean value)
Sets boolean property UpdateChangedColumns (UPDATE_CHANGED_COLUMNS_PTID).
Parameters:
value - Value to set property to

getDeleteDataSourceArguments

public JdapiIterator getDeleteDataSourceArguments()
Accessor for child DeleteDataSourceArgument objects (DELETE_DATA_SOURCE_ARGUMENT_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of DeleteDataSourceArgument objects

getDeleteDataSourceColumns

public JdapiIterator getDeleteDataSourceColumns()
Accessor for child DeleteDataSourceColumn objects (DELETE_DATA_SOURCE_COLUMN_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of DeleteDataSourceColumn objects

getInsertDataSourceArguments

public JdapiIterator getInsertDataSourceArguments()
Accessor for child InsertDataSourceArgument objects (INSERT_DATA_SOURCE_ARGUMENT_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of InsertDataSourceArgument objects

getInsertDataSourceColumns

public JdapiIterator getInsertDataSourceColumns()
Accessor for child InsertDataSourceColumn objects (INSERT_DATA_SOURCE_COLUMN_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of InsertDataSourceColumn objects

getItems

public JdapiIterator getItems()
Accessor for child Item objects (ITEM_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of Item objects

getLockDataSourceArguments

public JdapiIterator getLockDataSourceArguments()
Accessor for child LockDataSourceArgument objects (LOCK_DATA_SOURCE_ARGUMENT_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of LockDataSourceArgument objects

getLockDataSourceColumns

public JdapiIterator getLockDataSourceColumns()
Accessor for child LockDataSourceColumn objects (LOCK_DATA_SOURCE_COLUMN_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of LockDataSourceColumn objects

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)

getNextNavigationBlockObject

public Block getNextNavigationBlockObject()
Get object property NextNavigationBlockObject (NEXT_NAVIGATION_BLOCK_OBJECT_PTID).
Returns:
Value of property (null if none)

setNextNavigationBlockObject

public void setNextNavigationBlockObject(Block value)
Set object property NextNavigationBlockObject (NEXT_NAVIGATION_BLOCK_OBJECT_PTID).
Parameters:
value - Block object to set property to

getOwner

public JdapiObject getOwner()
Get object property Owner (OWNER_PTID). The return value may be an instance of: ObjectGroup FormModule ObjectLibraryTab
Overrides:
getOwner in class oracle.forms.jdapi.BaseFormsObject
Returns:
Value of property downcast to a JdapiObject (null if none)

getPreviousNavigationBlockObject

public Block getPreviousNavigationBlockObject()
Get object property PreviousNavigationBlockObject (PREVIOUS_NAVIGATION_BLOCK_OBJECT_PTID).
Returns:
Value of property (null if none)

setPreviousNavigationBlockObject

public void setPreviousNavigationBlockObject(Block value)
Set object property PreviousNavigationBlockObject (PREVIOUS_NAVIGATION_BLOCK_OBJECT_PTID).
Parameters:
value - Block object to set property to

getQueryDataSourceArguments

public JdapiIterator getQueryDataSourceArguments()
Accessor for child QueryDataSourceArgument objects (QUERY_DATA_SOURCE_ARGUMENT_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of QueryDataSourceArgument objects

getQueryDataSourceColumns

public JdapiIterator getQueryDataSourceColumns()
Accessor for child QueryDataSourceColumn objects (QUERY_DATA_SOURCE_COLUMN_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of QueryDataSourceColumn objects

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

getRelations

public JdapiIterator getRelations()
Accessor for child Relation objects (RELATION_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of Relation objects

getScrollbarCanvasObject

public Canvas getScrollbarCanvasObject()
Get object property ScrollbarCanvasObject (SCROLLBAR_CANVAS_OBJECT_PTID).
Returns:
Value of property (null if none)

setScrollbarCanvasObject

public void setScrollbarCanvasObject(Canvas value)
Set object property ScrollbarCanvasObject (SCROLLBAR_CANVAS_OBJECT_PTID).
Parameters:
value - Canvas object to set property to

getScrollbarTabPageObject

public TabPage getScrollbarTabPageObject()
Get object property ScrollbarTabPageObject (SCROLLBAR_TABPAGE_OBJECT_PTID).
Returns:
Value of property (null if none)

setScrollbarTabPageObject

public void setScrollbarTabPageObject(TabPage value)
Set object property ScrollbarTabPageObject (SCROLLBAR_TABPAGE_OBJECT_PTID).
Parameters:
value - TabPage object to set property to

getSource

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

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

getUpdateDataSourceArguments

public JdapiIterator getUpdateDataSourceArguments()
Accessor for child UpdateDataSourceArgument objects (UPDATE_DATA_SOURCE_ARGUMENT_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of UpdateDataSourceArgument objects

getUpdateDataSourceColumns

public JdapiIterator getUpdateDataSourceColumns()
Accessor for child UpdateDataSourceColumn objects (UPDATE_DATA_SOURCE_COLUMN_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).
Returns:
Iterator of UpdateDataSourceColumn 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.