Class Graphics
- 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
Graphics
(long pd2fgra) Protected constructor, used internally to create Graphics objects.Constructor used to create Graphics objects in the context of a Canvas parent object.Constructor used to create Graphics objects in the context of a Canvas parent object.Graphics
(Canvas parent, String name, PropertyClass base) Constructor used to create Graphics objects in the context of a Canvas parent object.Constructor used to create Graphics objects in the context of a Graphics parent object.Constructor used to create Graphics objects in the context of a Graphics parent object.Graphics
(Graphics parent, String name, PropertyClass base) Constructor used to create Graphics objects in the context of a Graphics parent object.Graphics
(ObjectLibrary olb, ObjectLibraryTab tab, String name) Constructor used to create Graphics objects in the context of an ObjectLibraryTab parent object.Graphics
(ObjectLibrary olb, ObjectLibraryTab tab, String name, Graphics base) Constructor used to create Graphics objects in the context of an ObjectLibraryTab parent object.Graphics
(ObjectLibrary olb, ObjectLibraryTab tab, String name, PropertyClass base) Constructor used to create Graphics objects in the context of an ObjectLibraryTab parent object.Constructor used to create Graphics objects in the context of a TabPage parent object.Constructor used to create Graphics objects in the context of a TabPage parent object.Graphics
(TabPage parent, String name, PropertyClass base) Constructor used to create Graphics objects in the context of a TabPage 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.Creates a copy of the object as a child of 'parent'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'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.void
exportImage
(String filename) Exports an image embedded in a Graphics object to file.static Graphics
Find an instance of Graphics that is a child of a Canvas.static Graphics
Find an instance of Graphics that is a child of a Graphics.static Graphics
find
(ObjectLibraryTab parent, String name) Find an instance of Graphics that is a child of a ObjectLibraryTab.static Graphics
Find an instance of Graphics that is a child of a TabPage.int
Get number property ArrowStyle (ARROW_STYLE_PTID).Get text property BackColor (BACK_COLOR_PTID).int
getBevel()
Get number property Bevel (BEVEL_PTID).boolean
getBooleanProperty
(int propertyTypeId) Retrieves a boolean property from the referred object.int
Get number property CapStyle (CAP_STYLE_PTID).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.int
Get number property ClipHeight (CLIP_HEIGHT_PTID).int
Get number property ClipWidth (CLIP_WIDTH_PTID).int
Get number property ClipXPosition (CLIP_X_POSITION_PTID).int
Get number property ClipYPosition (CLIP_Y_POSITION_PTID).Accessor for child CompoundText objects (COMPOUNDTEXT_PTID).int
Get number property CornerRadiusX (CORNER_RADIUS_X_PTID).int
Get number property CornerRadiusY (CORNER_RADIUS_Y_PTID).int
Get number property CustomSpacing (CUSTOM_SPACING_PTID).int
Get number property DashStyle (DASH_STYLE_PTID).int
Get number property DisplayQuality (DISPLAY_QUALITY_PTID).int
Get number property DistanceBetweenRecords (DISTANCE_BETWEEN_RECORDS_PTID).Get text property EdgeBackColor (EDGE_BACK_COLOR_PTID).Get text property EdgeForegroundColor (EDGE_FOREGROUND_COLOR_PTID).Get text property EdgePattern (EDGE_PATTERN_PTID).Get text property FillPattern (FILL_PATTERN_PTID).Get text property ForegroundColor (FOREGROUND_COLOR_PTID).int
Get number property FrameAlign (FRAME_ALIGN_PTID).Get text property FrameTitle (FRAME_TITLE_PTID).int
Get number property FrameTitleAlign (FRAME_TITLE_ALIGN_PTID).Get text property FrameTitleBackColor (FRAME_TITLE_BACK_COLOR_PTID).Get text property FrameTitleFillPattern (FRAME_TITLE_FILL_PATTERN_PTID).Get text property FrameTitleFontName (FRAME_TITLE_FONT_NAME_PTID).int
Get number property FrameTitleFontSize (FRAME_TITLE_FONT_SIZE_PTID).int
Get number property FrameTitleFontSpacing (FRAME_TITLE_FONT_SPACING_PTID).int
Get number property FrameTitleFontStyle (FRAME_TITLE_FONT_STYLE_PTID).int
Get number property FrameTitleFontWeight (FRAME_TITLE_FONT_WEIGHT_PTID).Get text property FrameTitleForegroundColor (FRAME_TITLE_FOREGROUND_COLOR_PTID).int
Get number property FrameTitleOffset (FRAME_TITLE_OFFSET_PTID).int
Get number property FrameTitleSpacing (FRAME_TITLE_SPACING_PTID).Get text property FrameTitleVisualAttributeName (FRAME_TITLE_VISUALATTRIBUTE_NAME_PTID).Get object property FrameTitleVisualAttributeObject (FRAME_TITLE_VISUALATTRIBUTE_OBJECT_PTID).Accessor for child Graphics objects (GRAPHIC_PTID).Get text property GraphicsFontColor (GRAPHICS_FONT_COLOR_PTID).int
Get number property GraphicsFontColorCode (GRAPHICS_FONT_COLOR_CODE_PTID).Get text property GraphicsFontName (GRAPHICS_FONT_NAME_PTID).int
Get number property GraphicsFontSize (GRAPHICS_FONT_SIZE_PTID).int
Get number property GraphicsFontSpacing (GRAPHICS_FONT_SPACING_PTID).int
Get number property GraphicsFontStyle (GRAPHICS_FONT_STYLE_PTID).int
Get number property GraphicsFontWeight (GRAPHICS_FONT_WEIGHT_PTID).Get text property GraphicsText (GRAPHICS_TEXT_PTID).int
Get number property GraphicsType (GRAPHICS_TYPE_PTID).int
Get number property Height (HEIGHT_PTID).int
Get number property HorizontalJustification (HORIZONTAL_JUSTIFICATION_PTID).int
Get number property HorizontalMargin (HORIZONTAL_MARGIN_PTID).int
Get number property HorizontalObjectOffset (HORIZONTAL_OBJECT_OFFSET_PTID).int
Get number property HorizontalOrigin (HORIZONTAL_ORIGIN_PTID).int
Get number property ImageDepth (IMAGE_DEPTH_PTID).int
Get number property ImageFormat (IMAGE_FORMAT_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.int
Get number property InternalEndAngle (INTERNAL_END_ANGLE_PTID).int
Get number property InternalLineWidth (INTERNAL_LINE_WIDTH_PTID).int
Get number property InternalRotationAngle (INTERNAL_ROTATION_ANGLE_PTID).int
Get number property InternalStartAngle (INTERNAL_START_ANGLE_PTID).Gets the metadata object for the specified object.int
Get number property JoinStyle (JOIN_STYLE_PTID).int
Get number property LanguageDirection (LANGUAGE_DIRECTION_PTID).Get text property LayoutDataBlockName (LAYOUT_DATA_BLOCK_NAME_PTID).int
Get number property LayoutStyle (LAYOUT_STYLE_PTID).int
Get number property LineSpacing (LINE_SPACING_PTID).int
Get number property MaximumObjs (MAXIMUM_OBJS_PTID).Return an iterator over the meta properties in object referred.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.Accessor for child Point objects (POINT_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...int
Get number property RecordsDisplayCount (RECORDS_DISPLAY_COUNT_PTID).int
Get number property ScrollbarAlign (SCROLLBAR_ALIGN_PTID).int
Get number property ScrollbarWidth (SCROLLBAR_WIDTH_PTID).int
Get number property SingleObjectAlign (SINGLE_OBJECT_ALIGN_PTID).Get object property Source (SOURCE_PTID).int
Get number property StartPromptAlign (START_PROMPT_ALIGN_PTID).int
Get number property StartPromptOffset (START_PROMPT_OFFSET_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.Get text property TabPageName (TABPAGE_NAME_PTID).Get object property TabPageObject (TABPAGE_OBJECT_PTID).int
Get number property TitleReadingOrder (TITLE_READING_ORDER_PTID).int
Get number property TopPromptAlign (TOP_PROMPT_ALIGN_PTID).int
Get number property TopPromptOffset (TOP_PROMPT_OFFSET_PTID).int
Gets the HtmlForms object type ID.int
Get number property UpdateLayout (UPDATE_LAYOUT_PTID).int
Get number property VerticalJustification (VERTICAL_JUSTIFICATION_PTID).int
Get number property VerticalMargin (VERTICAL_MARGIN_PTID).int
Get number property VerticalObjectOffset (VERTICAL_OBJECT_OFFSET_PTID).int
Get number property VerticalOrigin (VERTICAL_ORIGIN_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 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
importImage
(String filename, int format) Imports an image and embeds it in the Graphics object.void
inheritProperty
(int propertyTypeId) Resets a property to it's default value (confusing name eh?).boolean
Get boolean property AllowExpansion (ALLOW_EXPANSION_PTID).boolean
Get boolean property AllowMultiLinePrompts (ALLOW_MULTI_LINE_PROMPTS_PTID).boolean
Get boolean property AllowStartAttachmentPrompts (ALLOW_START_ATTACHMENT_PROMPTS_PTID).boolean
Get boolean property AllowTopAttachmentPrompts (ALLOW_TOP_ATTACHMENT_PROMPTS_PTID).boolean
Get boolean property BoundingBoxScalable (BOUNDING_BOX_SCALABLE_PTID).boolean
isClosed()
Get boolean property Closed (CLOSED_PTID).boolean
Get boolean property DirtyInfo (DIRTY_INFO_PTID).boolean
isDither()
Get boolean property Dither (DITHER_PTID).boolean
Get boolean property FixedBoundingBox (FIXED_BOUNDING_BOX_PTID).boolean
Get boolean property FontScaleable (FONT_SCALEABLE_PTID).boolean
Get boolean property ShowScrollbar (SHOW_SCROLLBAR_PTID).boolean
Get boolean property Shrinkwrap (SHRINKWRAP_PTID).boolean
Checks if the object is subclassed from another object.boolean
Get boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).boolean
Determines whether this Java instance references a valid Forms object.boolean
Get boolean property VerticalFill (VERTICAL_FILL_PTID).boolean
Get boolean property WrapText (WRAP_TEXT_PTID).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
setAllowExpansion
(boolean value) Sets boolean property AllowExpansion (ALLOW_EXPANSION_PTID).void
setAllowMultiLinePrompts
(boolean value) Sets boolean property AllowMultiLinePrompts (ALLOW_MULTI_LINE_PROMPTS_PTID).void
setAllowStartAttachmentPrompts
(boolean value) Sets boolean property AllowStartAttachmentPrompts (ALLOW_START_ATTACHMENT_PROMPTS_PTID).void
setAllowTopAttachmentPrompts
(boolean value) Sets boolean property AllowTopAttachmentPrompts (ALLOW_TOP_ATTACHMENT_PROMPTS_PTID).void
setArrowStyle
(int value) Sets number property ArrowStyle (ARROW_STYLE_PTID).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
setBoundingBoxScalable
(boolean value) Sets boolean property BoundingBoxScalable (BOUNDING_BOX_SCALABLE_PTID).void
setCapStyle
(int value) Sets number property CapStyle (CAP_STYLE_PTID).void
setClientInfo
(Object clientInfo) Sets the client information.void
setClipHeight
(int value) Sets number property ClipHeight (CLIP_HEIGHT_PTID).void
setClipWidth
(int value) Sets number property ClipWidth (CLIP_WIDTH_PTID).void
setClipXPosition
(int value) Sets number property ClipXPosition (CLIP_X_POSITION_PTID).void
setClipYPosition
(int value) Sets number property ClipYPosition (CLIP_Y_POSITION_PTID).void
setClosed
(boolean value) Sets boolean property Closed (CLOSED_PTID).void
setCornerRadiusX
(int value) Sets number property CornerRadiusX (CORNER_RADIUS_X_PTID).void
setCornerRadiusY
(int value) Sets number property CornerRadiusY (CORNER_RADIUS_Y_PTID).void
setCustomSpacing
(int value) Sets number property CustomSpacing (CUSTOM_SPACING_PTID).void
setDashStyle
(int value) Sets number property DashStyle (DASH_STYLE_PTID).void
setDirtyInfo
(boolean value) Sets boolean property DirtyInfo (DIRTY_INFO_PTID).void
setDisplayQuality
(int value) Sets number property DisplayQuality (DISPLAY_QUALITY_PTID).void
setDistanceBetweenRecords
(int value) Sets number property DistanceBetweenRecords (DISTANCE_BETWEEN_RECORDS_PTID).void
setDither
(boolean value) Sets boolean property Dither (DITHER_PTID).void
setEdgeBackColor
(String value) Sets text property EdgeBackColor (EDGE_BACK_COLOR_PTID).void
setEdgeForegroundColor
(String value) Sets text property EdgeForegroundColor (EDGE_FOREGROUND_COLOR_PTID).void
setEdgePattern
(String value) Sets text property EdgePattern (EDGE_PATTERN_PTID).void
setFillPattern
(String value) Sets text property FillPattern (FILL_PATTERN_PTID).void
setFixedBoundingBox
(boolean value) Sets boolean property FixedBoundingBox (FIXED_BOUNDING_BOX_PTID).void
setFontScaleable
(boolean value) Sets boolean property FontScaleable (FONT_SCALEABLE_PTID).void
setForegroundColor
(String value) Sets text property ForegroundColor (FOREGROUND_COLOR_PTID).void
setFrameAlign
(int value) Sets number property FrameAlign (FRAME_ALIGN_PTID).void
setFrameTitle
(String value) Sets text property FrameTitle (FRAME_TITLE_PTID).void
setFrameTitleAlign
(int value) Sets number property FrameTitleAlign (FRAME_TITLE_ALIGN_PTID).void
setFrameTitleBackColor
(String value) Sets text property FrameTitleBackColor (FRAME_TITLE_BACK_COLOR_PTID).void
setFrameTitleFillPattern
(String value) Sets text property FrameTitleFillPattern (FRAME_TITLE_FILL_PATTERN_PTID).void
setFrameTitleFontName
(String value) Sets text property FrameTitleFontName (FRAME_TITLE_FONT_NAME_PTID).void
setFrameTitleFontSize
(int value) Sets number property FrameTitleFontSize (FRAME_TITLE_FONT_SIZE_PTID).void
setFrameTitleFontSpacing
(int value) Sets number property FrameTitleFontSpacing (FRAME_TITLE_FONT_SPACING_PTID).void
setFrameTitleFontStyle
(int value) Sets number property FrameTitleFontStyle (FRAME_TITLE_FONT_STYLE_PTID).void
setFrameTitleFontWeight
(int value) Sets number property FrameTitleFontWeight (FRAME_TITLE_FONT_WEIGHT_PTID).void
Sets text property FrameTitleForegroundColor (FRAME_TITLE_FOREGROUND_COLOR_PTID).void
setFrameTitleOffset
(int value) Sets number property FrameTitleOffset (FRAME_TITLE_OFFSET_PTID).void
setFrameTitleSpacing
(int value) Sets number property FrameTitleSpacing (FRAME_TITLE_SPACING_PTID).void
Sets text property FrameTitleVisualAttributeName (FRAME_TITLE_VISUALATTRIBUTE_NAME_PTID).void
Set object property FrameTitleVisualAttributeObject (FRAME_TITLE_VISUALATTRIBUTE_OBJECT_PTID).void
setGraphicsFontColor
(String value) Sets text property GraphicsFontColor (GRAPHICS_FONT_COLOR_PTID).void
setGraphicsFontColorCode
(int value) Sets number property GraphicsFontColorCode (GRAPHICS_FONT_COLOR_CODE_PTID).void
setGraphicsFontName
(String value) Sets text property GraphicsFontName (GRAPHICS_FONT_NAME_PTID).void
setGraphicsFontSize
(int value) Sets number property GraphicsFontSize (GRAPHICS_FONT_SIZE_PTID).void
setGraphicsFontSpacing
(int value) Sets number property GraphicsFontSpacing (GRAPHICS_FONT_SPACING_PTID).void
setGraphicsFontStyle
(int value) Sets number property GraphicsFontStyle (GRAPHICS_FONT_STYLE_PTID).void
setGraphicsFontWeight
(int value) Sets number property GraphicsFontWeight (GRAPHICS_FONT_WEIGHT_PTID).void
setGraphicsText
(String value) Sets text property GraphicsText (GRAPHICS_TEXT_PTID).void
setGraphicsType
(int value) Sets number property GraphicsType (GRAPHICS_TYPE_PTID).void
setHeight
(int value) Sets number property Height (HEIGHT_PTID).void
setHorizontalJustification
(int value) Sets number property HorizontalJustification (HORIZONTAL_JUSTIFICATION_PTID).void
setHorizontalMargin
(int value) Sets number property HorizontalMargin (HORIZONTAL_MARGIN_PTID).void
setHorizontalObjectOffset
(int value) Sets number property HorizontalObjectOffset (HORIZONTAL_OBJECT_OFFSET_PTID).void
setHorizontalOrigin
(int value) Sets number property HorizontalOrigin (HORIZONTAL_ORIGIN_PTID).void
setImageDepth
(int value) Sets number property ImageDepth (IMAGE_DEPTH_PTID).void
setImageFormat
(int value) Sets number property ImageFormat (IMAGE_FORMAT_PTID).void
setIntegerProperty
(int propertyTypeId, int propertyValue) Sets the value of the specified object integer property.void
setInternalEndAngle
(int value) Sets number property InternalEndAngle (INTERNAL_END_ANGLE_PTID).void
setInternalLineWidth
(int value) Sets number property InternalLineWidth (INTERNAL_LINE_WIDTH_PTID).void
setInternalRotationAngle
(int value) Sets number property InternalRotationAngle (INTERNAL_ROTATION_ANGLE_PTID).void
setInternalStartAngle
(int value) Sets number property InternalStartAngle (INTERNAL_START_ANGLE_PTID).void
setJoinStyle
(int value) Sets number property JoinStyle (JOIN_STYLE_PTID).void
setLanguageDirection
(int value) Sets number property LanguageDirection (LANGUAGE_DIRECTION_PTID).void
setLayoutDataBlockName
(String value) Sets text property LayoutDataBlockName (LAYOUT_DATA_BLOCK_NAME_PTID).void
setLayoutStyle
(int value) Sets number property LayoutStyle (LAYOUT_STYLE_PTID).void
setLineSpacing
(int value) Sets number property LineSpacing (LINE_SPACING_PTID).void
setMaximumObjs
(int value) Sets number property MaximumObjs (MAXIMUM_OBJS_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
setRecordsDisplayCount
(int value) Sets number property RecordsDisplayCount (RECORDS_DISPLAY_COUNT_PTID).void
setScrollbarAlign
(int value) Sets number property ScrollbarAlign (SCROLLBAR_ALIGN_PTID).void
setScrollbarWidth
(int value) Sets number property ScrollbarWidth (SCROLLBAR_WIDTH_PTID).void
setShowScrollbar
(boolean value) Sets boolean property ShowScrollbar (SHOW_SCROLLBAR_PTID).void
setShrinkwrap
(boolean value) Sets boolean property Shrinkwrap (SHRINKWRAP_PTID).void
setSingleObjectAlign
(int value) Sets number property SingleObjectAlign (SINGLE_OBJECT_ALIGN_PTID).void
setStartPromptAlign
(int value) Sets number property StartPromptAlign (START_PROMPT_ALIGN_PTID).void
setStartPromptOffset
(int value) Sets number property StartPromptOffset (START_PROMPT_OFFSET_PTID).void
setStringProperty
(int propertyTypeId, String propertyValue) Sets the value of the specified string property for the object.void
setSubclassParent
(JdapiObject parent) Change the subclassing parent of the object referred.void
setSubclassSubObject
(boolean value) Sets boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).void
setTabPageName
(String value) Sets text property TabPageName (TABPAGE_NAME_PTID).void
setTabPageObject
(TabPage value) Set object property TabPageObject (TABPAGE_OBJECT_PTID).void
setTitleReadingOrder
(int value) Sets number property TitleReadingOrder (TITLE_READING_ORDER_PTID).void
setTopPromptAlign
(int value) Sets number property TopPromptAlign (TOP_PROMPT_ALIGN_PTID).void
setTopPromptOffset
(int value) Sets number property TopPromptOffset (TOP_PROMPT_OFFSET_PTID).void
setUpdateLayout
(int value) Sets number property UpdateLayout (UPDATE_LAYOUT_PTID).void
setVerticalFill
(boolean value) Sets boolean property VerticalFill (VERTICAL_FILL_PTID).void
setVerticalJustification
(int value) Sets number property VerticalJustification (VERTICAL_JUSTIFICATION_PTID).void
setVerticalMargin
(int value) Sets number property VerticalMargin (VERTICAL_MARGIN_PTID).void
setVerticalObjectOffset
(int value) Sets number property VerticalObjectOffset (VERTICAL_OBJECT_OFFSET_PTID).void
setVerticalOrigin
(int value) Sets number property VerticalOrigin (VERTICAL_ORIGIN_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
setWrapText
(boolean value) Sets boolean property WrapText (WRAP_TEXT_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
-
Graphics
Constructor used to create Graphics objects in the context of a Canvas parent object.- Parameters:
parent
- Parent objectname
- Name of the new object
-
Graphics
Constructor used to create Graphics objects in the context of a Canvas parent object. The newly created object is derived from the 'base' object.- Parameters:
parent
- Parent objectname
- Name of the new objectbase
- Graphics object to derive from
-
Graphics
Constructor used to create Graphics objects in the context of a Canvas 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
-
Graphics
Constructor used to create Graphics objects in the context of a Graphics parent object.- Parameters:
parent
- Parent objectname
- Name of the new object
-
Graphics
Constructor used to create Graphics objects in the context of a Graphics parent object. The newly created object is derived from the 'base' object.- Parameters:
parent
- Parent objectname
- Name of the new objectbase
- Graphics object to derive from
-
Graphics
Constructor used to create Graphics objects in the context of a Graphics 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
-
Graphics
Constructor used to create Graphics objects in the context of a TabPage parent object.- Parameters:
parent
- Parent objectname
- Name of the new object
-
Graphics
Constructor used to create Graphics objects in the context of a TabPage parent object. The newly created object is derived from the 'base' object.- Parameters:
parent
- Parent objectname
- Name of the new objectbase
- Graphics object to derive from
-
Graphics
Constructor used to create Graphics objects in the context of a TabPage 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
-
Graphics
Constructor used to create Graphics 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
-
Graphics
Constructor used to create Graphics 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
- Graphics object to derive from
-
Graphics
Constructor used to create Graphics 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
-
Graphics
protected Graphics(long pd2fgra) Protected constructor, used internally to create Graphics objects. This doesn't actually create a new Graphics, 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:
pd2fgra
- 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
-
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 Graphics that is a child of a Canvas.- 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 Graphics that is a child of a Graphics.- 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 Graphics that is a child of a TabPage.- 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 Graphics 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
-
importImage
Imports an image and embeds it in the Graphics object.- Parameters:
filename
- The filename to import the image from.format
- The image format. Should be one of the JdapiTypes.IMFM_*_CTID.
-
exportImage
Exports an image embedded in a Graphics object to file.- Parameters:
filename
- The filename to save the image to.
-
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
-
getEdgeBackColor
Get text property EdgeBackColor (EDGE_BACK_COLOR_PTID).- Returns:
- Value of property
-
setEdgeBackColor
Sets text property EdgeBackColor (EDGE_BACK_COLOR_PTID).- Parameters:
value
- Value to set property to
-
getEdgeForegroundColor
Get text property EdgeForegroundColor (EDGE_FOREGROUND_COLOR_PTID).- Returns:
- Value of property
-
setEdgeForegroundColor
Sets text property EdgeForegroundColor (EDGE_FOREGROUND_COLOR_PTID).- Parameters:
value
- Value to set property to
-
getEdgePattern
Get text property EdgePattern (EDGE_PATTERN_PTID).- Returns:
- Value of property
-
setEdgePattern
Sets text property EdgePattern (EDGE_PATTERN_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
-
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
-
getFrameTitle
Get text property FrameTitle (FRAME_TITLE_PTID).- Returns:
- Value of property
-
setFrameTitle
Sets text property FrameTitle (FRAME_TITLE_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleBackColor
Get text property FrameTitleBackColor (FRAME_TITLE_BACK_COLOR_PTID).- Returns:
- Value of property
-
setFrameTitleBackColor
Sets text property FrameTitleBackColor (FRAME_TITLE_BACK_COLOR_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleFillPattern
Get text property FrameTitleFillPattern (FRAME_TITLE_FILL_PATTERN_PTID).- Returns:
- Value of property
-
setFrameTitleFillPattern
Sets text property FrameTitleFillPattern (FRAME_TITLE_FILL_PATTERN_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleFontName
Get text property FrameTitleFontName (FRAME_TITLE_FONT_NAME_PTID).- Returns:
- Value of property
-
setFrameTitleFontName
Sets text property FrameTitleFontName (FRAME_TITLE_FONT_NAME_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleForegroundColor
Get text property FrameTitleForegroundColor (FRAME_TITLE_FOREGROUND_COLOR_PTID).- Returns:
- Value of property
-
setFrameTitleForegroundColor
Sets text property FrameTitleForegroundColor (FRAME_TITLE_FOREGROUND_COLOR_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleVisualAttributeName
Get text property FrameTitleVisualAttributeName (FRAME_TITLE_VISUALATTRIBUTE_NAME_PTID).- Returns:
- Value of property
-
setFrameTitleVisualAttributeName
Sets text property FrameTitleVisualAttributeName (FRAME_TITLE_VISUALATTRIBUTE_NAME_PTID).- Parameters:
value
- Value to set property to
-
getGraphicsFontColor
Get text property GraphicsFontColor (GRAPHICS_FONT_COLOR_PTID).- Returns:
- Value of property
-
setGraphicsFontColor
Sets text property GraphicsFontColor (GRAPHICS_FONT_COLOR_PTID).- Parameters:
value
- Value to set property to
-
getGraphicsFontName
Get text property GraphicsFontName (GRAPHICS_FONT_NAME_PTID).- Returns:
- Value of property
-
setGraphicsFontName
Sets text property GraphicsFontName (GRAPHICS_FONT_NAME_PTID).- Parameters:
value
- Value to set property to
-
getGraphicsText
Get text property GraphicsText (GRAPHICS_TEXT_PTID).- Returns:
- Value of property
-
setGraphicsText
Sets text property GraphicsText (GRAPHICS_TEXT_PTID).- Parameters:
value
- Value to set property to
-
getLayoutDataBlockName
Get text property LayoutDataBlockName (LAYOUT_DATA_BLOCK_NAME_PTID).- Returns:
- Value of property
-
setLayoutDataBlockName
Sets text property LayoutDataBlockName (LAYOUT_DATA_BLOCK_NAME_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
-
getTabPageName
Get text property TabPageName (TABPAGE_NAME_PTID).- Returns:
- Value of property
-
setTabPageName
Sets text property TabPageName (TABPAGE_NAME_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
-
getArrowStyle
public int getArrowStyle()Get number property ArrowStyle (ARROW_STYLE_PTID).- Returns:
- Value of property
-
setArrowStyle
public void setArrowStyle(int value) Sets number property ArrowStyle (ARROW_STYLE_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
-
getCapStyle
public int getCapStyle()Get number property CapStyle (CAP_STYLE_PTID).- Returns:
- Value of property
-
setCapStyle
public void setCapStyle(int value) Sets number property CapStyle (CAP_STYLE_PTID).- Parameters:
value
- Value to set property to
-
getClipHeight
public int getClipHeight()Get number property ClipHeight (CLIP_HEIGHT_PTID).- Returns:
- Value of property
-
setClipHeight
public void setClipHeight(int value) Sets number property ClipHeight (CLIP_HEIGHT_PTID).- Parameters:
value
- Value to set property to
-
getClipWidth
public int getClipWidth()Get number property ClipWidth (CLIP_WIDTH_PTID).- Returns:
- Value of property
-
setClipWidth
public void setClipWidth(int value) Sets number property ClipWidth (CLIP_WIDTH_PTID).- Parameters:
value
- Value to set property to
-
getClipXPosition
public int getClipXPosition()Get number property ClipXPosition (CLIP_X_POSITION_PTID).- Returns:
- Value of property
-
setClipXPosition
public void setClipXPosition(int value) Sets number property ClipXPosition (CLIP_X_POSITION_PTID).- Parameters:
value
- Value to set property to
-
getClipYPosition
public int getClipYPosition()Get number property ClipYPosition (CLIP_Y_POSITION_PTID).- Returns:
- Value of property
-
setClipYPosition
public void setClipYPosition(int value) Sets number property ClipYPosition (CLIP_Y_POSITION_PTID).- Parameters:
value
- Value to set property to
-
getCornerRadiusX
public int getCornerRadiusX()Get number property CornerRadiusX (CORNER_RADIUS_X_PTID).- Returns:
- Value of property
-
setCornerRadiusX
public void setCornerRadiusX(int value) Sets number property CornerRadiusX (CORNER_RADIUS_X_PTID).- Parameters:
value
- Value to set property to
-
getCornerRadiusY
public int getCornerRadiusY()Get number property CornerRadiusY (CORNER_RADIUS_Y_PTID).- Returns:
- Value of property
-
setCornerRadiusY
public void setCornerRadiusY(int value) Sets number property CornerRadiusY (CORNER_RADIUS_Y_PTID).- Parameters:
value
- Value to set property to
-
getCustomSpacing
public int getCustomSpacing()Get number property CustomSpacing (CUSTOM_SPACING_PTID).- Returns:
- Value of property
-
setCustomSpacing
public void setCustomSpacing(int value) Sets number property CustomSpacing (CUSTOM_SPACING_PTID).- Parameters:
value
- Value to set property to
-
getDashStyle
public int getDashStyle()Get number property DashStyle (DASH_STYLE_PTID).- Returns:
- Value of property
-
setDashStyle
public void setDashStyle(int value) Sets number property DashStyle (DASH_STYLE_PTID).- Parameters:
value
- Value to set property to
-
getDisplayQuality
public int getDisplayQuality()Get number property DisplayQuality (DISPLAY_QUALITY_PTID).- Returns:
- Value of property
-
setDisplayQuality
public void setDisplayQuality(int value) Sets number property DisplayQuality (DISPLAY_QUALITY_PTID).- Parameters:
value
- Value to set property to
-
getDistanceBetweenRecords
public int getDistanceBetweenRecords()Get number property DistanceBetweenRecords (DISTANCE_BETWEEN_RECORDS_PTID).- Returns:
- Value of property
-
setDistanceBetweenRecords
public void setDistanceBetweenRecords(int value) Sets number property DistanceBetweenRecords (DISTANCE_BETWEEN_RECORDS_PTID).- Parameters:
value
- Value to set property to
-
getFrameAlign
public int getFrameAlign()Get number property FrameAlign (FRAME_ALIGN_PTID).- Returns:
- Value of property
-
setFrameAlign
public void setFrameAlign(int value) Sets number property FrameAlign (FRAME_ALIGN_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleAlign
public int getFrameTitleAlign()Get number property FrameTitleAlign (FRAME_TITLE_ALIGN_PTID).- Returns:
- Value of property
-
setFrameTitleAlign
public void setFrameTitleAlign(int value) Sets number property FrameTitleAlign (FRAME_TITLE_ALIGN_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleFontSize
public int getFrameTitleFontSize()Get number property FrameTitleFontSize (FRAME_TITLE_FONT_SIZE_PTID).- Returns:
- Value of property
-
setFrameTitleFontSize
public void setFrameTitleFontSize(int value) Sets number property FrameTitleFontSize (FRAME_TITLE_FONT_SIZE_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleFontSpacing
public int getFrameTitleFontSpacing()Get number property FrameTitleFontSpacing (FRAME_TITLE_FONT_SPACING_PTID).- Returns:
- Value of property
-
setFrameTitleFontSpacing
public void setFrameTitleFontSpacing(int value) Sets number property FrameTitleFontSpacing (FRAME_TITLE_FONT_SPACING_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleFontStyle
public int getFrameTitleFontStyle()Get number property FrameTitleFontStyle (FRAME_TITLE_FONT_STYLE_PTID).- Returns:
- Value of property
-
setFrameTitleFontStyle
public void setFrameTitleFontStyle(int value) Sets number property FrameTitleFontStyle (FRAME_TITLE_FONT_STYLE_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleFontWeight
public int getFrameTitleFontWeight()Get number property FrameTitleFontWeight (FRAME_TITLE_FONT_WEIGHT_PTID).- Returns:
- Value of property
-
setFrameTitleFontWeight
public void setFrameTitleFontWeight(int value) Sets number property FrameTitleFontWeight (FRAME_TITLE_FONT_WEIGHT_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleOffset
public int getFrameTitleOffset()Get number property FrameTitleOffset (FRAME_TITLE_OFFSET_PTID).- Returns:
- Value of property
-
setFrameTitleOffset
public void setFrameTitleOffset(int value) Sets number property FrameTitleOffset (FRAME_TITLE_OFFSET_PTID).- Parameters:
value
- Value to set property to
-
getFrameTitleSpacing
public int getFrameTitleSpacing()Get number property FrameTitleSpacing (FRAME_TITLE_SPACING_PTID).- Returns:
- Value of property
-
setFrameTitleSpacing
public void setFrameTitleSpacing(int value) Sets number property FrameTitleSpacing (FRAME_TITLE_SPACING_PTID).- Parameters:
value
- Value to set property to
-
getGraphicsFontColorCode
public int getGraphicsFontColorCode()Get number property GraphicsFontColorCode (GRAPHICS_FONT_COLOR_CODE_PTID).- Returns:
- Value of property
-
setGraphicsFontColorCode
public void setGraphicsFontColorCode(int value) Sets number property GraphicsFontColorCode (GRAPHICS_FONT_COLOR_CODE_PTID).- Parameters:
value
- Value to set property to
-
getGraphicsFontSize
public int getGraphicsFontSize()Get number property GraphicsFontSize (GRAPHICS_FONT_SIZE_PTID).- Returns:
- Value of property
-
setGraphicsFontSize
public void setGraphicsFontSize(int value) Sets number property GraphicsFontSize (GRAPHICS_FONT_SIZE_PTID).- Parameters:
value
- Value to set property to
-
getGraphicsFontSpacing
public int getGraphicsFontSpacing()Get number property GraphicsFontSpacing (GRAPHICS_FONT_SPACING_PTID).- Returns:
- Value of property
-
setGraphicsFontSpacing
public void setGraphicsFontSpacing(int value) Sets number property GraphicsFontSpacing (GRAPHICS_FONT_SPACING_PTID).- Parameters:
value
- Value to set property to
-
getGraphicsFontStyle
public int getGraphicsFontStyle()Get number property GraphicsFontStyle (GRAPHICS_FONT_STYLE_PTID).- Returns:
- Value of property
-
setGraphicsFontStyle
public void setGraphicsFontStyle(int value) Sets number property GraphicsFontStyle (GRAPHICS_FONT_STYLE_PTID).- Parameters:
value
- Value to set property to
-
getGraphicsFontWeight
public int getGraphicsFontWeight()Get number property GraphicsFontWeight (GRAPHICS_FONT_WEIGHT_PTID).- Returns:
- Value of property
-
setGraphicsFontWeight
public void setGraphicsFontWeight(int value) Sets number property GraphicsFontWeight (GRAPHICS_FONT_WEIGHT_PTID).- Parameters:
value
- Value to set property to
-
getGraphicsType
public int getGraphicsType()Get number property GraphicsType (GRAPHICS_TYPE_PTID).- Returns:
- Value of property
-
setGraphicsType
public void setGraphicsType(int value) Sets number property GraphicsType (GRAPHICS_TYPE_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
-
getHorizontalJustification
public int getHorizontalJustification()Get number property HorizontalJustification (HORIZONTAL_JUSTIFICATION_PTID).- Returns:
- Value of property
-
setHorizontalJustification
public void setHorizontalJustification(int value) Sets number property HorizontalJustification (HORIZONTAL_JUSTIFICATION_PTID).- Parameters:
value
- Value to set property to
-
getHorizontalMargin
public int getHorizontalMargin()Get number property HorizontalMargin (HORIZONTAL_MARGIN_PTID).- Returns:
- Value of property
-
setHorizontalMargin
public void setHorizontalMargin(int value) Sets number property HorizontalMargin (HORIZONTAL_MARGIN_PTID).- Parameters:
value
- Value to set property to
-
getHorizontalObjectOffset
public int getHorizontalObjectOffset()Get number property HorizontalObjectOffset (HORIZONTAL_OBJECT_OFFSET_PTID).- Returns:
- Value of property
-
setHorizontalObjectOffset
public void setHorizontalObjectOffset(int value) Sets number property HorizontalObjectOffset (HORIZONTAL_OBJECT_OFFSET_PTID).- Parameters:
value
- Value to set property to
-
getHorizontalOrigin
public int getHorizontalOrigin()Get number property HorizontalOrigin (HORIZONTAL_ORIGIN_PTID).- Returns:
- Value of property
-
setHorizontalOrigin
public void setHorizontalOrigin(int value) Sets number property HorizontalOrigin (HORIZONTAL_ORIGIN_PTID).- Parameters:
value
- Value to set property to
-
getImageDepth
public int getImageDepth()Get number property ImageDepth (IMAGE_DEPTH_PTID).- Returns:
- Value of property
-
setImageDepth
public void setImageDepth(int value) Sets number property ImageDepth (IMAGE_DEPTH_PTID).- Parameters:
value
- Value to set property to
-
getImageFormat
public int getImageFormat()Get number property ImageFormat (IMAGE_FORMAT_PTID).- Returns:
- Value of property
-
setImageFormat
public void setImageFormat(int value) Sets number property ImageFormat (IMAGE_FORMAT_PTID).- Parameters:
value
- Value to set property to
-
getInternalEndAngle
public int getInternalEndAngle()Get number property InternalEndAngle (INTERNAL_END_ANGLE_PTID).- Returns:
- Value of property
-
setInternalEndAngle
public void setInternalEndAngle(int value) Sets number property InternalEndAngle (INTERNAL_END_ANGLE_PTID).- Parameters:
value
- Value to set property to
-
getInternalLineWidth
public int getInternalLineWidth()Get number property InternalLineWidth (INTERNAL_LINE_WIDTH_PTID).- Returns:
- Value of property
-
setInternalLineWidth
public void setInternalLineWidth(int value) Sets number property InternalLineWidth (INTERNAL_LINE_WIDTH_PTID).- Parameters:
value
- Value to set property to
-
getInternalRotationAngle
public int getInternalRotationAngle()Get number property InternalRotationAngle (INTERNAL_ROTATION_ANGLE_PTID).- Returns:
- Value of property
-
setInternalRotationAngle
public void setInternalRotationAngle(int value) Sets number property InternalRotationAngle (INTERNAL_ROTATION_ANGLE_PTID).- Parameters:
value
- Value to set property to
-
getInternalStartAngle
public int getInternalStartAngle()Get number property InternalStartAngle (INTERNAL_START_ANGLE_PTID).- Returns:
- Value of property
-
setInternalStartAngle
public void setInternalStartAngle(int value) Sets number property InternalStartAngle (INTERNAL_START_ANGLE_PTID).- Parameters:
value
- Value to set property to
-
getJoinStyle
public int getJoinStyle()Get number property JoinStyle (JOIN_STYLE_PTID).- Returns:
- Value of property
-
setJoinStyle
public void setJoinStyle(int value) Sets number property JoinStyle (JOIN_STYLE_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
-
getLayoutStyle
public int getLayoutStyle()Get number property LayoutStyle (LAYOUT_STYLE_PTID).- Returns:
- Value of property
-
setLayoutStyle
public void setLayoutStyle(int value) Sets number property LayoutStyle (LAYOUT_STYLE_PTID).- Parameters:
value
- Value to set property to
-
getLineSpacing
public int getLineSpacing()Get number property LineSpacing (LINE_SPACING_PTID).- Returns:
- Value of property
-
setLineSpacing
public void setLineSpacing(int value) Sets number property LineSpacing (LINE_SPACING_PTID).- Parameters:
value
- Value to set property to
-
getMaximumObjs
public int getMaximumObjs()Get number property MaximumObjs (MAXIMUM_OBJS_PTID).- Returns:
- Value of property
-
setMaximumObjs
public void setMaximumObjs(int value) Sets number property MaximumObjs (MAXIMUM_OBJS_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
-
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
-
getScrollbarAlign
public int getScrollbarAlign()Get number property ScrollbarAlign (SCROLLBAR_ALIGN_PTID).- Returns:
- Value of property
-
setScrollbarAlign
public void setScrollbarAlign(int value) Sets number property ScrollbarAlign (SCROLLBAR_ALIGN_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
-
getSingleObjectAlign
public int getSingleObjectAlign()Get number property SingleObjectAlign (SINGLE_OBJECT_ALIGN_PTID).- Returns:
- Value of property
-
setSingleObjectAlign
public void setSingleObjectAlign(int value) Sets number property SingleObjectAlign (SINGLE_OBJECT_ALIGN_PTID).- Parameters:
value
- Value to set property to
-
getStartPromptAlign
public int getStartPromptAlign()Get number property StartPromptAlign (START_PROMPT_ALIGN_PTID).- Returns:
- Value of property
-
setStartPromptAlign
public void setStartPromptAlign(int value) Sets number property StartPromptAlign (START_PROMPT_ALIGN_PTID).- Parameters:
value
- Value to set property to
-
getStartPromptOffset
public int getStartPromptOffset()Get number property StartPromptOffset (START_PROMPT_OFFSET_PTID).- Returns:
- Value of property
-
setStartPromptOffset
public void setStartPromptOffset(int value) Sets number property StartPromptOffset (START_PROMPT_OFFSET_PTID).- Parameters:
value
- Value to set property to
-
getTopPromptAlign
public int getTopPromptAlign()Get number property TopPromptAlign (TOP_PROMPT_ALIGN_PTID).- Returns:
- Value of property
-
setTopPromptAlign
public void setTopPromptAlign(int value) Sets number property TopPromptAlign (TOP_PROMPT_ALIGN_PTID).- Parameters:
value
- Value to set property to
-
getTopPromptOffset
public int getTopPromptOffset()Get number property TopPromptOffset (TOP_PROMPT_OFFSET_PTID).- Returns:
- Value of property
-
setTopPromptOffset
public void setTopPromptOffset(int value) Sets number property TopPromptOffset (TOP_PROMPT_OFFSET_PTID).- Parameters:
value
- Value to set property to
-
getTitleReadingOrder
public int getTitleReadingOrder()Get number property TitleReadingOrder (TITLE_READING_ORDER_PTID).- Returns:
- Value of property
-
setTitleReadingOrder
public void setTitleReadingOrder(int value) Sets number property TitleReadingOrder (TITLE_READING_ORDER_PTID).- Parameters:
value
- Value to set property to
-
getUpdateLayout
public int getUpdateLayout()Get number property UpdateLayout (UPDATE_LAYOUT_PTID).- Returns:
- Value of property
-
setUpdateLayout
public void setUpdateLayout(int value) Sets number property UpdateLayout (UPDATE_LAYOUT_PTID).- Parameters:
value
- Value to set property to
-
getVerticalJustification
public int getVerticalJustification()Get number property VerticalJustification (VERTICAL_JUSTIFICATION_PTID).- Returns:
- Value of property
-
setVerticalJustification
public void setVerticalJustification(int value) Sets number property VerticalJustification (VERTICAL_JUSTIFICATION_PTID).- Parameters:
value
- Value to set property to
-
getVerticalMargin
public int getVerticalMargin()Get number property VerticalMargin (VERTICAL_MARGIN_PTID).- Returns:
- Value of property
-
setVerticalMargin
public void setVerticalMargin(int value) Sets number property VerticalMargin (VERTICAL_MARGIN_PTID).- Parameters:
value
- Value to set property to
-
getVerticalObjectOffset
public int getVerticalObjectOffset()Get number property VerticalObjectOffset (VERTICAL_OBJECT_OFFSET_PTID).- Returns:
- Value of property
-
setVerticalObjectOffset
public void setVerticalObjectOffset(int value) Sets number property VerticalObjectOffset (VERTICAL_OBJECT_OFFSET_PTID).- Parameters:
value
- Value to set property to
-
getVerticalOrigin
public int getVerticalOrigin()Get number property VerticalOrigin (VERTICAL_ORIGIN_PTID).- Returns:
- Value of property
-
setVerticalOrigin
public void setVerticalOrigin(int value) Sets number property VerticalOrigin (VERTICAL_ORIGIN_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
-
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
-
isAllowExpansion
public boolean isAllowExpansion()Get boolean property AllowExpansion (ALLOW_EXPANSION_PTID).- Returns:
- Value of property
-
setAllowExpansion
public void setAllowExpansion(boolean value) Sets boolean property AllowExpansion (ALLOW_EXPANSION_PTID).- Parameters:
value
- Value to set property to
-
isAllowMultiLinePrompts
public boolean isAllowMultiLinePrompts()Get boolean property AllowMultiLinePrompts (ALLOW_MULTI_LINE_PROMPTS_PTID).- Returns:
- Value of property
-
setAllowMultiLinePrompts
public void setAllowMultiLinePrompts(boolean value) Sets boolean property AllowMultiLinePrompts (ALLOW_MULTI_LINE_PROMPTS_PTID).- Parameters:
value
- Value to set property to
-
isAllowStartAttachmentPrompts
public boolean isAllowStartAttachmentPrompts()Get boolean property AllowStartAttachmentPrompts (ALLOW_START_ATTACHMENT_PROMPTS_PTID).- Returns:
- Value of property
-
setAllowStartAttachmentPrompts
public void setAllowStartAttachmentPrompts(boolean value) Sets boolean property AllowStartAttachmentPrompts (ALLOW_START_ATTACHMENT_PROMPTS_PTID).- Parameters:
value
- Value to set property to
-
isAllowTopAttachmentPrompts
public boolean isAllowTopAttachmentPrompts()Get boolean property AllowTopAttachmentPrompts (ALLOW_TOP_ATTACHMENT_PROMPTS_PTID).- Returns:
- Value of property
-
setAllowTopAttachmentPrompts
public void setAllowTopAttachmentPrompts(boolean value) Sets boolean property AllowTopAttachmentPrompts (ALLOW_TOP_ATTACHMENT_PROMPTS_PTID).- Parameters:
value
- Value to set property to
-
isBoundingBoxScalable
public boolean isBoundingBoxScalable()Get boolean property BoundingBoxScalable (BOUNDING_BOX_SCALABLE_PTID).- Returns:
- Value of property
-
setBoundingBoxScalable
public void setBoundingBoxScalable(boolean value) Sets boolean property BoundingBoxScalable (BOUNDING_BOX_SCALABLE_PTID).- Parameters:
value
- Value to set property to
-
isClosed
public boolean isClosed()Get boolean property Closed (CLOSED_PTID).- Returns:
- Value of property
-
setClosed
public void setClosed(boolean value) Sets boolean property Closed (CLOSED_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
-
isDither
public boolean isDither()Get boolean property Dither (DITHER_PTID).- Returns:
- Value of property
-
setDither
public void setDither(boolean value) Sets boolean property Dither (DITHER_PTID).- Parameters:
value
- Value to set property to
-
isFixedBoundingBox
public boolean isFixedBoundingBox()Get boolean property FixedBoundingBox (FIXED_BOUNDING_BOX_PTID).- Returns:
- Value of property
-
setFixedBoundingBox
public void setFixedBoundingBox(boolean value) Sets boolean property FixedBoundingBox (FIXED_BOUNDING_BOX_PTID).- Parameters:
value
- Value to set property to
-
isFontScaleable
public boolean isFontScaleable()Get boolean property FontScaleable (FONT_SCALEABLE_PTID).- Returns:
- Value of property
-
setFontScaleable
public void setFontScaleable(boolean value) Sets boolean property FontScaleable (FONT_SCALEABLE_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
-
isShrinkwrap
public boolean isShrinkwrap()Get boolean property Shrinkwrap (SHRINKWRAP_PTID).- Returns:
- Value of property
-
setShrinkwrap
public void setShrinkwrap(boolean value) Sets boolean property Shrinkwrap (SHRINKWRAP_PTID).- Parameters:
value
- Value to set property to
-
isSubclassSubObject
public boolean isSubclassSubObject()Get boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).- Returns:
- Value of property
-
setSubclassSubObject
public void setSubclassSubObject(boolean value) Sets boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).- Parameters:
value
- Value to set property to
-
isVerticalFill
public boolean isVerticalFill()Get boolean property VerticalFill (VERTICAL_FILL_PTID).- Returns:
- Value of property
-
setVerticalFill
public void setVerticalFill(boolean value) Sets boolean property VerticalFill (VERTICAL_FILL_PTID).- Parameters:
value
- Value to set property to
-
isWrapText
public boolean isWrapText()Get boolean property WrapText (WRAP_TEXT_PTID).- Returns:
- Value of property
-
setWrapText
public void setWrapText(boolean value) Sets boolean property WrapText (WRAP_TEXT_PTID).- Parameters:
value
- Value to set property to
-
getCompoundTexts
Accessor for child CompoundText objects (COMPOUNDTEXT_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).- Returns:
- Iterator of CompoundText objects
-
getFrameTitleVisualAttributeObject
Get object property FrameTitleVisualAttributeObject (FRAME_TITLE_VISUALATTRIBUTE_OBJECT_PTID).- Returns:
- Value of property (null if none)
-
setFrameTitleVisualAttributeObject
Set object property FrameTitleVisualAttributeObject (FRAME_TITLE_VISUALATTRIBUTE_OBJECT_PTID).- Parameters:
value
- VisualAttribute object to set property to
-
getGraphicses
Accessor for child Graphics objects (GRAPHIC_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).- Returns:
- Iterator of Graphics objects
-
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 TabPage ObjectLibraryTab Graphics Canvas- Specified by:
getOwner
in interfaceJdapiObject
- Returns:
- Value of property downcast to a JdapiObject (null if none)
-
getPoints
Accessor for child Point objects (POINT_PTID). Gets list of child objects as an iterator (which implements Enumeration for simple traversal).- Returns:
- Iterator of Point objects
-
getSource
Get object property Source (SOURCE_PTID). The return value may be an instance of: Graphics PropertyClass- Returns:
- Value of property downcast to a JdapiObject (null if none)
-
getTabPageObject
Get object property TabPageObject (TABPAGE_OBJECT_PTID).- Returns:
- Value of property (null if none)
-
setTabPageObject
Set object property TabPageObject (TABPAGE_OBJECT_PTID).- Parameters:
value
- TabPage object to set property to
-
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.
-