Class Window
- All Implemented Interfaces:
JdapiObject
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
FieldsModifier and TypeFieldDescriptionprotected Object
Client info object held against this Forms object.protected long
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
ConstructorsModifierConstructorDescriptionprotected
Window
(long pd2fwin) Protected constructor, used internally to create Window objects.Window
(FormModule parent, String name) Constructor used to create Window objects in the context of a FormModule parent object.Window
(FormModule parent, String name, PropertyClass base) Constructor used to create Window objects in the context of a FormModule parent object.Window
(FormModule parent, String name, Window base) Constructor used to create Window objects in the context of a FormModule parent object.Window
(ObjectLibrary olb, ObjectLibraryTab tab, String name) Constructor used to create Window objects in the context of an ObjectLibraryTab parent object.Window
(ObjectLibrary olb, ObjectLibraryTab tab, String name, PropertyClass base) Constructor used to create Window objects in the context of an ObjectLibraryTab parent object.Window
(ObjectLibrary olb, ObjectLibraryTab tab, String name, Window base) Constructor used to create Window objects in the context of an ObjectLibraryTab parent object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
changeOwner
(JdapiObject newOwner) Assigns a new owner to the referred object.protected void
Used internally to flag this object as an invalid object.clone
(FormModule parent, String newName) Creates a copy of the object as a child of 'parent'clone
(JdapiObject parent, String newName) Creates a clone of the specified object, creating a new object with the given name and owner.clone
(ObjectLibraryTab parent, String newName) Creates a copy of the object as a child of 'parent'createSubclassedChild
(JdapiObject childOwner, 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 Window
find
(FormModule parent, String name) Find an instance of Window that is a child of a FormModule.static Window
find
(ObjectLibraryTab parent, String name) Find an instance of Window that is a child of a ObjectLibraryTab.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.getChildObjectProperty
(int propertyTypeId) Retrieves child objects for a given property value.Gets the class name of the object.Returns the client info object associated with this Object.Get text property Comment (COMMENT_PTID).Get text property FillPattern (FILL_PATTERN_PTID).Get text property FontName (FONT_NAME_PTID).int
Get number property FontSize (FONT_SIZE_PTID).int
Get number property FontSpacing (FONT_SPACING_PTID).int
Get number property FontStyle (FONT_STYLE_PTID).int
Get number property FontWeight (FONT_WEIGHT_PTID).Get text property ForegroundColor (FOREGROUND_COLOR_PTID).int
Get number property Height (HEIGHT_PTID).Get text property HelpBookTopic (HELP_BOOK_TOPIC_PTID).Get text property HorizontalToolbarCanvasName (HORIZONTALTOOLBAR_CANVAS_NAME_PTID).Get text property IconFilename (ICON_FILENAME_PTID).int
getIntegerProperty
(int propertyTypeId) Retrieves an integer property from the referred object.getIntegerPropertyString
(int propertyTypeId) Gets a numeric (long
) property value's text representation.Gets the metadata object for the specified object.int
Get number property LanguageDirection (LANGUAGE_DIRECTION_PTID).Return an iterator over the meta properties in object referred.Get text property MinimizeTitle (MINIMIZE_TITLE_PTID).Get object property Module (MODULE_PTID).getName()
Get text property Name (NAME_PTID).protected long
Gets the Forms API pointer for this object.getObjectProperty
(int propertyTypeId) Retrieves aJdapiObject
property from the referred object.protected long
getObjProp
(int propertyTypeId) Internal method used to get an object property value.Get the object instances owned by this particular object.getOwner()
Get object property Owner (OWNER_PTID).Get text property ParentFilename (PARENT_FILENAME_PTID).Get text property ParentFilepath (PARENT_FILEPATH_PTID).Get text property ParentModule (PARENT_MODULE_PTID).int
Get number property ParentModuleType (PARENT_MODULETYPE_PTID).Get text property ParentName (PARENT_NAME_PTID).int
Get number property ParentType (PARENT_TYPE_PTID).Returns the persistent client info Blob associated with this object.int
Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).Returns the persistent client info Java object associated with this object.Get text property PrimaryCanvas (PRIMARY_CANVAS_PTID).int
getPropertyState
(int propertyTypeId) Returns the current state of the specified property.getPropertyValueName
(int propertyTypeId, int val) Gets the string representation of a given property's value.getQualifiedName
(boolean includeModule) Gets a fully qualified name for the object in the format of: MODULE.OBJECT.CHILD.CHILD...Get object property Source (SOURCE_PTID).int
getStringIDProperty
(int propertyTypeId) Retrieves a special String ID (integer) property from the referred object.getStringProperty
(int propertyTypeId) Retrieves a string property from the referred object.Get Source (SOURCE_PTID) object property, i.e.getTitle()
Get text property Title (TITLE_PTID).int
Gets the HtmlForms object type ID.Get text property VerticalToolbarCanvasName (VERTICALTOOLBAR_CANVAS_NAME_PTID).Get text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).Get object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).int
getWidth()
Get number property Width (WIDTH_PTID).int
Get number property WindowStyle (WINDOW_STYLE_PTID).int
Get number property XPosition (X_POSITION_PTID).int
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?).boolean
Get boolean property Centered (CENTERED_PTID).boolean
Get boolean property ClearAllowed (CLEAR_ALLOWED_PTID).boolean
Get boolean property DirtyInfo (DIRTY_INFO_PTID).boolean
Get boolean property HideOnExit (HIDE_ON_EXIT_PTID).boolean
Get boolean property InheritMenu (INHERIT_MENU_PTID).boolean
Get boolean property MaximizeAllowed (MAXIMIZE_ALLOWED_PTID).boolean
Get boolean property MinimizeAllowed (MINIMIZE_ALLOWED_PTID).boolean
isModal()
Get boolean property Modal (MODAL_PTID).boolean
Get boolean property MoveAllowed (MOVE_ALLOWED_PTID).boolean
Get boolean property ResizeAllowed (RESIZE_ALLOWED_PTID).boolean
Get boolean property ShowHorizontalScrollbar (SHOW_HORIZONTAL_SCROLLBAR_PTID).boolean
Get boolean property ShowTitlebar (SHOW_TITLEBAR_PTID).boolean
Get boolean property ShowVerticalScrollbar (SHOW_VERTICAL_SCROLLBAR_PTID).boolean
Checks if the object is subclassed from another object.boolean
Get boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).boolean
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
Returns the FormAPI object type ID (x_OTID
inJdapiTypes
).void
reattach()
Reattaches subclassed object.void
setBackColor
(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
setCentered
(boolean value) Sets boolean property Centered (CENTERED_PTID).void
setClearAllowed
(boolean value) Sets boolean property ClearAllowed (CLEAR_ALLOWED_PTID).void
setClientInfo
(Object clientInfo) Sets the client information.void
setComment
(String value) Sets text property Comment (COMMENT_PTID).void
setDirtyInfo
(boolean value) Sets boolean property DirtyInfo (DIRTY_INFO_PTID).void
setFillPattern
(String value) Sets text property FillPattern (FILL_PATTERN_PTID).void
setFontName
(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
(String value) Sets text property ForegroundColor (FOREGROUND_COLOR_PTID).void
setHeight
(int value) Sets number property Height (HEIGHT_PTID).void
setHelpBookTopic
(String value) Sets text property HelpBookTopic (HELP_BOOK_TOPIC_PTID).void
setHideOnExit
(boolean value) Sets boolean property HideOnExit (HIDE_ON_EXIT_PTID).void
Sets text property HorizontalToolbarCanvasName (HORIZONTALTOOLBAR_CANVAS_NAME_PTID).void
setIconFilename
(String value) Sets text property IconFilename (ICON_FILENAME_PTID).void
setInheritMenu
(boolean value) Sets boolean property InheritMenu (INHERIT_MENU_PTID).void
setIntegerProperty
(int propertyTypeId, int propertyValue) Sets the value of the specified object integer property.void
setLanguageDirection
(int value) Sets number property LanguageDirection (LANGUAGE_DIRECTION_PTID).void
setMaximizeAllowed
(boolean value) Sets boolean property MaximizeAllowed (MAXIMIZE_ALLOWED_PTID).void
setMinimizeAllowed
(boolean value) Sets boolean property MinimizeAllowed (MINIMIZE_ALLOWED_PTID).void
setMinimizeTitle
(String value) Sets text property MinimizeTitle (MINIMIZE_TITLE_PTID).void
setModal
(boolean value) Sets boolean property Modal (MODAL_PTID).void
setMoveAllowed
(boolean value) Sets boolean property MoveAllowed (MOVE_ALLOWED_PTID).void
Sets text property Name (NAME_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
setParentFilename
(String value) Sets text property ParentFilename (PARENT_FILENAME_PTID).void
setParentFilepath
(String value) Sets text property ParentFilepath (PARENT_FILEPATH_PTID).void
setParentModule
(String value) Sets text property ParentModule (PARENT_MODULE_PTID).void
setParentModuleType
(int value) Sets number property ParentModuleType (PARENT_MODULETYPE_PTID).void
setParentName
(String value) Sets text property ParentName (PARENT_NAME_PTID).void
setParentType
(int value) Sets number property ParentType (PARENT_TYPE_PTID).void
Serializes any Java object which supports the Serializable interface to this object's Persistent Client Info.void
Sets persistent client info for this object.void
setPersistentClientInfoLength
(int value) Sets number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).void
setPrimaryCanvas
(String value) Sets text property PrimaryCanvas (PRIMARY_CANVAS_PTID).void
setResizeAllowed
(boolean value) Sets boolean property ResizeAllowed (RESIZE_ALLOWED_PTID).void
setShowHorizontalScrollbar
(boolean value) Sets boolean property ShowHorizontalScrollbar (SHOW_HORIZONTAL_SCROLLBAR_PTID).void
setShowTitlebar
(boolean value) Sets boolean property ShowTitlebar (SHOW_TITLEBAR_PTID).void
setShowVerticalScrollbar
(boolean value) Sets boolean property ShowVerticalScrollbar (SHOW_VERTICAL_SCROLLBAR_PTID).void
setStringProperty
(int propertyTypeId, 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
Sets text property Title (TITLE_PTID).void
Sets text property VerticalToolbarCanvasName (VERTICALTOOLBAR_CANVAS_NAME_PTID).void
setVisualAttributeName
(String value) Sets text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).void
Set object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).void
setWidth
(int value) Sets number property Width (WIDTH_PTID).void
setWindowStyle
(int value) Sets number property WindowStyle (WINDOW_STYLE_PTID).void
setXPosition
(int value) Sets number property XPosition (X_POSITION_PTID).void
setYPosition
(int value) Sets number property YPosition (Y_POSITION_PTID).toString()
Converts and returns the object properties to string format.void
Remove the subclassing parent of the object referred.
-
Field Details
-
m_pd2fob
protected transient long m_pd2fobThis is the d2fob pointer in the C ifjapi60 for the object that is derived from this class. -
m_clientInfo
Client info object held against this Forms object.
-
-
Constructor Details
-
Window
Constructor used to create Window objects in the context of a FormModule parent object.- Parameters:
parent
- Parent objectname
- Name of the new object
-
Window
Constructor used to create Window objects in the context of a FormModule parent object. The newly created object is derived from the 'base' object.- Parameters:
parent
- Parent objectname
- Name of the new objectbase
- Window object to derive from
-
Window
Constructor used to create Window objects in the context of a FormModule parent object. The newly created object is derived from the 'base' PropertyClass.- Parameters:
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive from
-
Window
Constructor used to create Window objects in the context of an ObjectLibraryTab parent object.- Parameters:
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 object
-
Window
Constructor used to create Window 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 intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectbase
- Window object to derive from
-
Window
Constructor used to create Window 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 intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectbase
- PropertyClass object to derive from
-
Window
protected Window(long pd2fwin) Protected constructor, used internally to create Window objects. This doesn't actually create a new Window, 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:
pd2fwin
- C pointer to Forms object
-
-
Method Details
-
getTypeId
public int getTypeId()Gets the HtmlForms object type ID.- Specified by:
getTypeId
in interfaceJdapiObject
- Returns:
- X_OTID ID for this object type
- See Also:
-
clone
Creates a copy of the object as a child of 'parent'- Parameters:
parent
- Parent objectnewName
- Name of object that's being created- Returns:
- Replicant object
-
clone
Creates a copy of the object as a child of 'parent'- Parameters:
parent
- Parent objectnewName
- Name of object that's being created- Returns:
- Replicant object
-
find
Find an instance of Window that is a child of a FormModule.- Parameters:
parent
- Parent object of object you wish to findname
- Name of object you wish to find- Returns:
- Object instance you are looking for, or null if none was found
-
find
Find an instance of Window that is a child of a ObjectLibraryTab.- Parameters:
parent
- Parent object of object you wish to findname
- Name of object you wish to find- Returns:
- Object instance you are looking for, or null if none was found
-
getBackColor
Get text property BackColor (BACK_COLOR_PTID).- Returns:
- Value of property
-
setBackColor
Sets text property BackColor (BACK_COLOR_PTID).- Parameters:
value
- Value to set property to
-
getComment
Get text property Comment (COMMENT_PTID).- Returns:
- Value of property
-
setComment
Sets text property Comment (COMMENT_PTID).- Parameters:
value
- Value to set property to
-
getFillPattern
Get text property FillPattern (FILL_PATTERN_PTID).- Returns:
- Value of property
-
setFillPattern
Sets text property FillPattern (FILL_PATTERN_PTID).- Parameters:
value
- Value to set property to
-
getFontName
Get text property FontName (FONT_NAME_PTID).- Returns:
- Value of property
-
setFontName
Sets text property FontName (FONT_NAME_PTID).- Parameters:
value
- Value to set property to
-
getForegroundColor
Get text property ForegroundColor (FOREGROUND_COLOR_PTID).- Returns:
- Value of property
-
setForegroundColor
Sets text property ForegroundColor (FOREGROUND_COLOR_PTID).- Parameters:
value
- Value to set property to
-
getHelpBookTopic
Get text property HelpBookTopic (HELP_BOOK_TOPIC_PTID).- Returns:
- Value of property
-
setHelpBookTopic
Sets text property HelpBookTopic (HELP_BOOK_TOPIC_PTID).- Parameters:
value
- Value to set property to
-
getHorizontalToolbarCanvasName
Get text property HorizontalToolbarCanvasName (HORIZONTALTOOLBAR_CANVAS_NAME_PTID).- Returns:
- Value of property
-
setHorizontalToolbarCanvasName
Sets text property HorizontalToolbarCanvasName (HORIZONTALTOOLBAR_CANVAS_NAME_PTID).- Parameters:
value
- Value to set property to
-
getIconFilename
Get text property IconFilename (ICON_FILENAME_PTID).- Returns:
- Value of property
-
setIconFilename
Sets text property IconFilename (ICON_FILENAME_PTID).- Parameters:
value
- Value to set property to
-
getMinimizeTitle
Get text property MinimizeTitle (MINIMIZE_TITLE_PTID).- Returns:
- Value of property
-
setMinimizeTitle
Sets text property MinimizeTitle (MINIMIZE_TITLE_PTID).- Parameters:
value
- Value to set property to
-
getName
Get text property Name (NAME_PTID).- Specified by:
getName
in interfaceJdapiObject
- Returns:
- Value of property
-
setName
Sets text property Name (NAME_PTID).- Parameters:
value
- Value to set property to
-
getParentFilename
Get text property ParentFilename (PARENT_FILENAME_PTID).- Returns:
- Value of property
-
setParentFilename
Sets text property ParentFilename (PARENT_FILENAME_PTID).- Parameters:
value
- Value to set property to
-
getParentFilepath
Get text property ParentFilepath (PARENT_FILEPATH_PTID).- Returns:
- Value of property
-
setParentFilepath
Sets text property ParentFilepath (PARENT_FILEPATH_PTID).- Parameters:
value
- Value to set property to
-
getParentModule
Get text property ParentModule (PARENT_MODULE_PTID).- Returns:
- Value of property
-
setParentModule
Sets text property ParentModule (PARENT_MODULE_PTID).- Parameters:
value
- Value to set property to
-
getParentName
Get text property ParentName (PARENT_NAME_PTID).- Returns:
- Value of property
-
setParentName
Sets text property ParentName (PARENT_NAME_PTID).- Parameters:
value
- Value to set property to
-
getPrimaryCanvas
Get text property PrimaryCanvas (PRIMARY_CANVAS_PTID).- Returns:
- Value of property
-
setPrimaryCanvas
Sets text property PrimaryCanvas (PRIMARY_CANVAS_PTID).- Parameters:
value
- Value to set property to
-
getTitle
Get text property Title (TITLE_PTID).- Returns:
- Value of property
-
setTitle
Sets text property Title (TITLE_PTID).- Parameters:
value
- Value to set property to
-
getVisualAttributeName
Get text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).- Returns:
- Value of property
-
setVisualAttributeName
Sets text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).- Parameters:
value
- Value to set property to
-
getVerticalToolbarCanvasName
Get text property VerticalToolbarCanvasName (VERTICALTOOLBAR_CANVAS_NAME_PTID).- Returns:
- Value of property
-
setVerticalToolbarCanvasName
Sets text property VerticalToolbarCanvasName (VERTICALTOOLBAR_CANVAS_NAME_PTID).- Parameters:
value
- Value to set property to
-
getBevel
public int getBevel()Get number property Bevel (BEVEL_PTID).- Returns:
- Value of property
-
setBevel
public void setBevel(int value) Sets number property Bevel (BEVEL_PTID).- Parameters:
value
- Value to set property to
-
getFontSize
public int getFontSize()Get number property FontSize (FONT_SIZE_PTID).- Returns:
- Value of property
-
setFontSize
public void setFontSize(int value) Sets number property FontSize (FONT_SIZE_PTID).- Parameters:
value
- Value to set property to
-
getFontSpacing
public int getFontSpacing()Get number property FontSpacing (FONT_SPACING_PTID).- Returns:
- Value of property
-
setFontSpacing
public void setFontSpacing(int value) Sets number property FontSpacing (FONT_SPACING_PTID).- Parameters:
value
- Value to set property to
-
getFontStyle
public int getFontStyle()Get number property FontStyle (FONT_STYLE_PTID).- Returns:
- Value of property
-
setFontStyle
public void setFontStyle(int value) Sets number property FontStyle (FONT_STYLE_PTID).- Parameters:
value
- Value to set property to
-
getFontWeight
public int getFontWeight()Get number property FontWeight (FONT_WEIGHT_PTID).- Returns:
- Value of property
-
setFontWeight
public void setFontWeight(int value) Sets number property FontWeight (FONT_WEIGHT_PTID).- Parameters:
value
- Value to set property to
-
getHeight
public int getHeight()Get number property Height (HEIGHT_PTID).- Returns:
- Value of property
-
setHeight
public void setHeight(int value) Sets number property Height (HEIGHT_PTID).- Parameters:
value
- Value to set property to
-
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
-
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
-
getWidth
public int getWidth()Get number property Width (WIDTH_PTID).- Returns:
- Value of property
-
setWidth
public void setWidth(int value) Sets number property Width (WIDTH_PTID).- Parameters:
value
- Value to set property to
-
getWindowStyle
public int getWindowStyle()Get number property WindowStyle (WINDOW_STYLE_PTID).- Returns:
- Value of property
-
setWindowStyle
public void setWindowStyle(int value) Sets number property WindowStyle (WINDOW_STYLE_PTID).- Parameters:
value
- Value to set property to
-
getXPosition
public int getXPosition()Get number property XPosition (X_POSITION_PTID).- Returns:
- Value of property
-
setXPosition
public void setXPosition(int value) Sets number property XPosition (X_POSITION_PTID).- Parameters:
value
- Value to set property to
-
getYPosition
public int getYPosition()Get number property YPosition (Y_POSITION_PTID).- Returns:
- Value of property
-
setYPosition
public void setYPosition(int value) Sets number property YPosition (Y_POSITION_PTID).- Parameters:
value
- Value to set property to
-
isCentered
public boolean isCentered()Get boolean property Centered (CENTERED_PTID).- Returns:
- Value of property
-
setCentered
public void setCentered(boolean value) Sets boolean property Centered (CENTERED_PTID).- Parameters:
value
- Value to set property to
-
isClearAllowed
public boolean isClearAllowed()Get boolean property ClearAllowed (CLEAR_ALLOWED_PTID).- Returns:
- Value of property
-
setClearAllowed
public void setClearAllowed(boolean value) Sets boolean property ClearAllowed (CLEAR_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
-
isHideOnExit
public boolean isHideOnExit()Get boolean property HideOnExit (HIDE_ON_EXIT_PTID).- Returns:
- Value of property
-
setHideOnExit
public void setHideOnExit(boolean value) Sets boolean property HideOnExit (HIDE_ON_EXIT_PTID).- Parameters:
value
- Value to set property to
-
isInheritMenu
public boolean isInheritMenu()Get boolean property InheritMenu (INHERIT_MENU_PTID).- Returns:
- Value of property
-
setInheritMenu
public void setInheritMenu(boolean value) Sets boolean property InheritMenu (INHERIT_MENU_PTID).- Parameters:
value
- Value to set property to
-
isMaximizeAllowed
public boolean isMaximizeAllowed()Get boolean property MaximizeAllowed (MAXIMIZE_ALLOWED_PTID).- Returns:
- Value of property
-
setMaximizeAllowed
public void setMaximizeAllowed(boolean value) Sets boolean property MaximizeAllowed (MAXIMIZE_ALLOWED_PTID).- Parameters:
value
- Value to set property to
-
isMinimizeAllowed
public boolean isMinimizeAllowed()Get boolean property MinimizeAllowed (MINIMIZE_ALLOWED_PTID).- Returns:
- Value of property
-
setMinimizeAllowed
public void setMinimizeAllowed(boolean value) Sets boolean property MinimizeAllowed (MINIMIZE_ALLOWED_PTID).- Parameters:
value
- Value to set property to
-
isModal
public boolean isModal()Get boolean property Modal (MODAL_PTID).- Returns:
- Value of property
-
setModal
public void setModal(boolean value) Sets boolean property Modal (MODAL_PTID).- Parameters:
value
- Value to set property to
-
isMoveAllowed
public boolean isMoveAllowed()Get boolean property MoveAllowed (MOVE_ALLOWED_PTID).- Returns:
- Value of property
-
setMoveAllowed
public void setMoveAllowed(boolean value) Sets boolean property MoveAllowed (MOVE_ALLOWED_PTID).- Parameters:
value
- Value to set property to
-
isResizeAllowed
public boolean isResizeAllowed()Get boolean property ResizeAllowed (RESIZE_ALLOWED_PTID).- Returns:
- Value of property
-
setResizeAllowed
public void setResizeAllowed(boolean value) Sets boolean property ResizeAllowed (RESIZE_ALLOWED_PTID).- Parameters:
value
- Value to set property to
-
isShowHorizontalScrollbar
public boolean isShowHorizontalScrollbar()Get boolean property ShowHorizontalScrollbar (SHOW_HORIZONTAL_SCROLLBAR_PTID).- Returns:
- Value of property
-
setShowHorizontalScrollbar
public void setShowHorizontalScrollbar(boolean value) Sets boolean property ShowHorizontalScrollbar (SHOW_HORIZONTAL_SCROLLBAR_PTID).- Parameters:
value
- Value to set property to
-
isShowTitlebar
public boolean isShowTitlebar()Get boolean property ShowTitlebar (SHOW_TITLEBAR_PTID).- Returns:
- Value of property
-
setShowTitlebar
public void setShowTitlebar(boolean value) Sets boolean property ShowTitlebar (SHOW_TITLEBAR_PTID).- Parameters:
value
- Value to set property to
-
isShowVerticalScrollbar
public boolean isShowVerticalScrollbar()Get boolean property ShowVerticalScrollbar (SHOW_VERTICAL_SCROLLBAR_PTID).- Returns:
- Value of property
-
setShowVerticalScrollbar
public void setShowVerticalScrollbar(boolean value) Sets boolean property ShowVerticalScrollbar (SHOW_VERTICAL_SCROLLBAR_PTID).- Parameters:
value
- Value to set property to
-
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
-
getModule
Get object property Module (MODULE_PTID). The return value may be an instance of: MenuModule ObjectLibrary FormModule- Specified by:
getModule
in interfaceJdapiObject
- Returns:
- Value of property downcast to a JdapiObject (null if none)
-
getOwner
Get object property Owner (OWNER_PTID). The return value may be an instance of: ObjectGroup FormModule ObjectLibraryTab- Specified by:
getOwner
in interfaceJdapiObject
- Returns:
- Value of property downcast to a JdapiObject (null if none)
-
getSource
Get object property Source (SOURCE_PTID). The return value may be an instance of: Window PropertyClass- Returns:
- Value of property downcast to a JdapiObject (null if none)
-
getVisualAttributeObject
Get object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).- Returns:
- Value of property (null if none)
-
setVisualAttributeObject
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
inJdapiTypes
). This should always be the same value as returned forgetTypeId
. The difference between the two methods is thatqueryType
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 usegetTypeID
instead.- Specified by:
queryType
in interfaceJdapiObject
- Returns:
- x_OTID an object type ID as defined in
JdapiTypes
.
-
setClientInfo
Sets the client information. Since theclientInfo
is ajava.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 theclientInfo
.This client info object is not persistent and will be lost when the session ends.
- Specified by:
setClientInfo
in interfaceJdapiObject
- Parameters:
clientInfo
- client info to be associated with the 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 usingsetClientObject
.- Specified by:
getClientInfo
in interfaceJdapiObject
- Returns:
- the client info object associated with this object.
-
getPersistentClientInfoBlob
Returns the persistent client info Blob associated with this object.- Specified by:
getPersistentClientInfoBlob
in interfaceJdapiObject
- Returns:
Blob
containing client info.
-
getPersistentClientInfoObject
Returns the persistent client info Java object associated with this object.- Specified by:
getPersistentClientInfoObject
in interfaceJdapiObject
- Returns:
- java.lang.Object serialized into the Forms object.
-
setPersistentClientInfo
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 interfaceJdapiObject
- Parameters:
val
- aBlob
object containing client info.
-
setPersistentClientInfo
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 interfaceJdapiObject
- Parameters:
obj
- any Serializable object containing client info.
-
equals
Compares two objects and determines if they are equal.- Specified by:
equals
in interfaceJdapiObject
- Parameters:
obj
- object to be compared.- Returns:
true
if the two objects are equal; returnsfalse
if they are not equal.
-
clone
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 theparent
parameter, and specifying a new name for the block in thenewName
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 interfaceJdapiObject
- Parameters:
parent
- owner of the new object.newName
- name of the new object.- Returns:
- the clone of the object.
-
changeOwner
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 interfaceJdapiObject
- Parameters:
newOwner
- the new owner of referred object; specify null if you want the object to have no owner.- Throws:
JdapiException
- ifnewOwner
is in a different module.
-
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 interfaceJdapiObject
- Overrides:
toString
in classObject
- 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 toisValidFormsObject()
on the block should returnfalse
.- Specified by:
isValidFormsObject
in interfaceJdapiObject
- 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 interfaceJdapiObject
-
move
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 thenextObject
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 interfaceJdapiObject
- Parameters:
next
- the object next to which the specified object is to be moved.- Throws:
JdapiException
- if you attempt to move an object next to an object that does not share the same owner or is not of the samme type.
-
getBooleanProperty
public boolean getBooleanProperty(int propertyTypeId) Retrieves a boolean property from the referred object.- Specified by:
getBooleanProperty
in interfaceJdapiObject
- Parameters:
propertyTypeId
- property type ID for which a boolean value is returned.- Returns:
- the boolean property value.
-
getStringProperty
Retrieves a string property from the referred object.- Specified by:
getStringProperty
in interfaceJdapiObject
- 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 interfaceJdapiObject
- 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 interfaceJdapiObject
- Parameters:
propertyTypeId
- property type ID for which a String ID value is returned.- Returns:
- the integer String ID property value.
-
getPropertyValueName
Description copied from interface:JdapiObject
Gets the string representation of a given property's value.- Specified by:
getPropertyValueName
in interfaceJdapiObject
- Parameters:
propertyTypeId
- Property numberval
- Value of property- Returns:
- String representation
-
getIntegerPropertyString
Description copied from interface:JdapiObject
Gets a numeric (long
) property value's text representation.- Specified by:
getIntegerPropertyString
in interfaceJdapiObject
- 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 theContextCache
to lookup/instantiate the Java representation of the object.- Parameters:
propertyTypeId
- Number identifying the property- Returns:
- Property's value
- See Also:
-
ContextCache
JdapiObject.getObjectProperty(int)
-
getObjectProperty
Description copied from interface:JdapiObject
Retrieves aJdapiObject
property from the referred object. For example, if you pass the integerpropertyTypeId
for an Item in a Block to this method, it returns the Item.- Specified by:
getObjectProperty
in interfaceJdapiObject
- Parameters:
propertyTypeId
- property type ID for which a JdapiObject value is returned.- Returns:
- the JdapiObject property value.
-
getChildObjectProperty
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 examplegetBlocks()
on the FormModule, as it involves fewer API calls. However,getChildObjectProperty
should be sufficient if you only have apropertyTypeId
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 interfaceJdapiObject
- 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 interfaceJdapiObject
- 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
Description copied from interface:JdapiObject
Sets the value of the specified string property for the object.- Specified by:
setStringProperty
in interfaceJdapiObject
- 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 interfaceJdapiObject
- 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 propertyval
- Value to set the property to- See Also:
-
setObjectProperty
Sets the value of the specified object object property value.- Specified by:
setObjectProperty
in interfaceJdapiObject
- 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 interfaceJdapiObject
- 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 interfaceJdapiObject
- Parameters:
propertyTypeId
- Number that identified the property
-
hasInheritedProperty
public boolean hasInheritedProperty(int propertyTypeId) Checks if a property is inherited.- Specified by:
hasInheritedProperty
in interfaceJdapiObject
- 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 interfaceJdapiObject
- 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 interfaceJdapiObject
- 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 interfaceJdapiObject
- Parameters:
propertyTypeId
- The type id of the property.- Returns:
- integer 0 through 3 representing one of the states.
-
isSubclassed
public boolean isSubclassed()Checks if the object is subclassed from another object.- Specified by:
isSubclassed
in interfaceJdapiObject
- Returns:
- 'true' if the object is subclassed, 'false' otherwise
-
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 interfaceJdapiObject
- Returns:
- Value of property downcast to a BaseFormsObject (null if none of object does not have this property)
-
setSubclassParent
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 interfaceJdapiObject
- Parameters:
parent
- The parent object. If this is null, the child the referred object will become an orphan. This is the way to unset the subclassing parent of an object.
-
unsetSubclassParent
public void unsetSubclassParent()Remove the subclassing parent of the object referred.The subclassing will be removed completely if it existed and the object will now contain the default values.
-
createSubclassedChild
Subclass the referred object. The child will be owned by the referred object specified.- Specified by:
createSubclassedChild
in interfaceJdapiObject
- 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 interfaceJdapiObject
-
getOwnedObjects
Get the object instances owned by this particular object.- Specified by:
getOwnedObjects
in interfaceJdapiObject
- Returns:
- Iterator of JdapiObjects
-
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 interfaceJdapiObject
- Returns:
- Name of "class" of Forms object
-
getQualifiedName
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 interfaceJdapiObject
- Parameters:
includeModule
- Include the module name
-
getJdapiMetaObject
Gets the metadata object for the specified object.- Specified by:
getJdapiMetaObject
in interfaceJdapiObject
- Returns:
- the metadata object for the specified object.
-
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 interfaceJdapiObject
- Returns:
- an enumeration of the specified object meta properties.
-