VisualState

java.lang.Object
- oracle.forms.jdapi.VisualState

All Implemented Interfaces:

JdapiObject
```
public class VisualState
extends java.lang.Object
```
Object to represent a Forms VisualState object. This is an encapsulation of the Forms C API d2fvst.
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

Fields
Modifier and Type	Field and Description
`protected java.lang.Object`	`m_clientInfo` Client info object held against this Forms object.
`protected long`	`m_pd2fob` This is the d2fob pointer in the C ifjapi60 for the object that is derived from this class.

Fields inherited from interface oracle.forms.jdapi.JdapiObject
PROPERTY_DEFAULT_VALUE, PROPERTY_INHERITED_VALUE, PROPERTY_OVERRIDDEN_DEFAULT_VALUE, PROPERTY_OVERRIDDEN_INHERITED_VALUE, PROPERTY_STATE_UNKNOWN

Constructor Summary

Constructors
Modifier	Constructor and Description
	`VisualState(Canvas parent, java.lang.String name)` Constructor used to create VisualState objects in the context of a Canvas parent object.
	`VisualState(Canvas parent, java.lang.String name, PropertyClass base)` Constructor used to create VisualState objects in the context of a Canvas parent object.
	`VisualState(Canvas parent, java.lang.String name, VisualState base)` Constructor used to create VisualState objects in the context of a Canvas parent object.
`protected`	`VisualState(long pd2fvst)` Protected constructor, used internally to create VisualState objects.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeOwner(JdapiObject newOwner)` Assigns a new owner to the referred object.
`protected void`	`clearObjectPointer()` Used internally to flag this object as an invalid object.
`VisualState`	`clone(Canvas parent, java.lang.String newName)` Creates a copy of the object as a child of 'parent'
`JdapiObject`	`clone(JdapiObject parent, java.lang.String newName)` Creates a clone of the specified object, creating a new object with the given name and owner.
`JdapiObject`	`createSubclassedChild(JdapiObject childOwner, java.lang.String childName)` Subclass the referred object.
`void`	`destroy()` Destroys the object - this removes the object from it's context.
`boolean`	`equals(JdapiObject obj)` Compares two objects and determines if they are equal.
`static VisualState`	`find(Canvas parent, java.lang.String name)` Find an instance of VisualState that is a child of a Canvas.
`int`	`getArrowStyle()` Get number property ArrowStyle (ARROW_STYLE_PTID).
`java.lang.String`	`getBackColor()` Get text property BackColor (BACK_COLOR_PTID).
`boolean`	`getBooleanProperty(int propertyTypeId)` Retrieves a boolean property from the referred object.
`int`	`getCapStyle()` Get number property CapStyle (CAP_STYLE_PTID).
`int`	`getCharacterCellHden()` Get number property CharacterCellHden (CHARACTER_CELL_HDEN_PTID).
`int`	`getCharacterCellHnum()` Get number property CharacterCellHnum (CHARACTER_CELL_HNUM_PTID).
`int`	`getCharacterCellVden()` Get number property CharacterCellVden (CHARACTER_CELL_VDEN_PTID).
`int`	`getCharacterCellVnum()` Get number property CharacterCellVnum (CHARACTER_CELL_VNUM_PTID).
`JdapiIterator`	`getChildObjectProperty(int propertyTypeId)` Retrieves child objects for a given property value.
`java.lang.String`	`getClassName()` Gets the class name of the object.
`java.lang.Object`	`getClientInfo()` Returns the client info object associated with this Object.
`int`	`getCornerRadiusX()` Get number property CornerRadiusX (CORNER_RADIUS_X_PTID).
`int`	`getCornerRadiusY()` Get number property CornerRadiusY (CORNER_RADIUS_Y_PTID).
`int`	`getDashStyle()` Get number property DashStyle (DASH_STYLE_PTID).
`int`	`getDisplayQuality()` Get number property DisplayQuality (DISPLAY_QUALITY_PTID).
`int`	`getDrawingHden()` Get number property DrawingHden (DRAWING_HDEN_PTID).
`int`	`getDrawingHnum()` Get number property DrawingHnum (DRAWING_HNUM_PTID).
`int`	`getDrawingWden()` Get number property DrawingWden (DRAWING_WDEN_PTID).
`int`	`getDrawingWnum()` Get number property DrawingWnum (DRAWING_WNUM_PTID).
`java.lang.String`	`getEdgeBackColor()` Get text property EdgeBackColor (EDGE_BACK_COLOR_PTID).
`java.lang.String`	`getEdgeForegroundColor()` Get text property EdgeForegroundColor (EDGE_FOREGROUND_COLOR_PTID).
`java.lang.String`	`getEdgePattern()` Get text property EdgePattern (EDGE_PATTERN_PTID).
`int`	`getEditorHeight()` Get number property EditorHeight (EDITOR_HEIGHT_PTID).
`int`	`getEditorWidth()` Get number property EditorWidth (EDITOR_WIDTH_PTID).
`java.lang.String`	`getFillPattern()` Get text property FillPattern (FILL_PATTERN_PTID).
`java.lang.String`	`getFontName()` Get text property FontName (FONT_NAME_PTID).
`int`	`getFontSize()` Get number property FontSize (FONT_SIZE_PTID).
`int`	`getFontSpacing()` Get number property FontSpacing (FONT_SPACING_PTID).
`int`	`getFontStyle()` Get number property FontStyle (FONT_STYLE_PTID).
`int`	`getFontWeight()` Get number property FontWeight (FONT_WEIGHT_PTID).
`java.lang.String`	`getForegroundColor()` Get text property ForegroundColor (FOREGROUND_COLOR_PTID).
`int`	`getFrameTitleAlign()` Get number property FrameTitleAlign (FRAME_TITLE_ALIGN_PTID).
`int`	`getFrameTitleOffset()` Get number property FrameTitleOffset (FRAME_TITLE_OFFSET_PTID).
`int`	`getFrameTitleSpacing()` Get number property FrameTitleSpacing (FRAME_TITLE_SPACING_PTID).
`int`	`getGridIntervalCnt()` Get number property GridIntervalCnt (GRID_INTERVAL_CNT_PTID).
`int`	`getGridSnapCnt()` Get number property GridSnapCnt (GRID_SNAP_CNT_PTID).
`int`	`getGridUnitCnt()` Get number property GridUnitCnt (GRID_UNIT_CNT_PTID).
`int`	`getIntegerProperty(int propertyTypeId)` Retrieves an integer property from the referred object.
`java.lang.String`	`getIntegerPropertyString(int propertyTypeId)` Gets a numeric (`long`) property value's text representation.
`int`	`getInternalLineWidth()` Get number property InternalLineWidth (INTERNAL_LINE_WIDTH_PTID).
`int`	`getInternalRotationAngle()` Get number property InternalRotationAngle (INTERNAL_ROTATION_ANGLE_PTID).
`JdapiMetaObject`	`getJdapiMetaObject()` Gets the metadata object for the specified object.
`JdapiIterator`	`getMetaProperties()` Return an iterator over the meta properties in object referred.
`JdapiObject`	`getModule()` Get Module (MODULE_PTID) object property.
`java.lang.String`	`getName()` Get the Name property (NAME_PTID) of this object.
`protected long`	`getObjectPointer()` Gets the Forms API pointer for this object.
`JdapiObject`	`getObjectProperty(int propertyTypeId)` Retrieves a `JdapiObject` property from the referred object.
`protected long`	`getObjProp(int propertyTypeId)` Internal method used to get an object property value.
`JdapiIterator`	`getOwnedObjects()` Get the object instances owned by this particular object.
`JdapiObject`	`getOwner()` Get Owner (OWNER_PTID) object property.
`Blob`	`getPersistentClientInfoBlob()` Returns the persistent client info Blob associated with this object.
`java.lang.Object`	`getPersistentClientInfoObject()` Returns the persistent client info Java object associated with this object.
`int`	`getPropertyState(int propertyTypeId)` Returns the current state of the specified property.
`java.lang.String`	`getPropertyValueName(int propertyTypeId, int val)` Gets the string representation of a given property's value.
`java.lang.String`	`getQualifiedName(boolean includeModule)` Gets a fully qualified name for the object in the format of: MODULE.OBJECT.CHILD.CHILD...
`int`	`getRulerMajor()` Get number property RulerMajor (RULER_MAJOR_PTID).
`int`	`getRulerMinor()` Get number property RulerMinor (RULER_MINOR_PTID).
`int`	`getRulerUnit()` Get number property RulerUnit (RULER_UNIT_PTID).
`int`	`getStringIDProperty(int propertyTypeId)` Retrieves a special String ID (integer) property from the referred object.
`java.lang.String`	`getStringProperty(int propertyTypeId)` Retrieves a string property from the referred object.
`JdapiObject`	`getSubclassParent()` Get Source (SOURCE_PTID) object property, i.e.
`int`	`getTypeId()` Gets the HtmlForms object type ID.
`int`	`getWindowHeight()` Get number property WindowHeight (WINDOW_HEIGHT_PTID).
`int`	`getWindowWidth()` Get number property WindowWidth (WINDOW_WIDTH_PTID).
`int`	`getWindowXPosition()` Get number property WindowXPosition (WINDOW_X_POSITION_PTID).
`int`	`getWindowYPosition()` Get number property WindowYPosition (WINDOW_Y_POSITION_PTID).
`int`	`getZoomLevel()` Get number property ZoomLevel (ZOOM_LEVEL_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`	`isBoundingBoxScalable()` Get boolean property BoundingBoxScalable (BOUNDING_BOX_SCALABLE_PTID).
`boolean`	`isCenterTracking()` Get boolean property CenterTracking (CENTER_TRACKING_PTID).
`boolean`	`isClosed()` Get boolean property Closed (CLOSED_PTID).
`boolean`	`isDither()` Get boolean property Dither (DITHER_PTID).
`boolean`	`isFixedBoundingBox()` Get boolean property FixedBoundingBox (FIXED_BOUNDING_BOX_PTID).
`boolean`	`isFontScaleable()` Get boolean property FontScaleable (FONT_SCALEABLE_PTID).
`boolean`	`isGridFlag()` Get boolean property GridFlag (GRID_FLAG_PTID).
`boolean`	`isGridsnapFlag()` Get boolean property GridsnapFlag (GRIDSNAP_FLAG_PTID).
`boolean`	`isPagebreakFlag()` Get boolean property PagebreakFlag (PAGEBREAK_FLAG_PTID).
`boolean`	`isPageCountSeq()` Get boolean property PageCountSeq (PAGE_COUNT_SEQ_PTID).
`boolean`	`isResizableFlag()` Get boolean property ResizableFlag (RESIZABLE_FLAG_PTID).
`boolean`	`isRulerFlag()` Get boolean property RulerFlag (RULER_FLAG_PTID).
`boolean`	`isRulerGuideFlag()` Get boolean property RulerGuideFlag (RULER_GUIDE_FLAG_PTID).
`boolean`	`isShowCanvas()` Get boolean property ShowCanvas (SHOW_CANVAS_PTID).
`boolean`	`isShowView()` Get boolean property ShowView (SHOW_VIEW_PTID).
`boolean`	`isStatusLineFlag()` Get boolean property StatusLineFlag (STATUS_LINE_FLAG_PTID).
`boolean`	`isSubclassed()` Checks if the object is subclassed from another object.
`boolean`	`isToolpaletteFlag()` Get boolean property ToolpaletteFlag (TOOLPALETTE_FLAG_PTID).
`boolean`	`isValidFormsObject()` Determines whether this Java instance references a valid Forms object.
`boolean`	`isVisualStateValid()` Get boolean property VisualStateValid (VISUAL_STATE_VALID_PTID).
`boolean`	`isWrapText()` 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`	`queryType()` Returns the FormAPI object type ID (x`_OTID` in `JdapiTypes`).
`void`	`reattach()` Reattaches subclassed object.
`void`	`setArrowStyle(int value)` Sets number property ArrowStyle (ARROW_STYLE_PTID).
`void`	`setBackColor(java.lang.String value)` Sets text property BackColor (BACK_COLOR_PTID).
`void`	`setBooleanProperty(int propertyTypeId, boolean propertyValue)` Sets the value of the specified boolean property belonging to the referred object.
`void`	`setBoundingBoxScalable(boolean value)` Sets boolean property BoundingBoxScalable (BOUNDING_BOX_SCALABLE_PTID).
`void`	`setCapStyle(int value)` Sets number property CapStyle (CAP_STYLE_PTID).
`void`	`setCenterTracking(boolean value)` Sets boolean property CenterTracking (CENTER_TRACKING_PTID).
`void`	`setCharacterCellHden(int value)` Sets number property CharacterCellHden (CHARACTER_CELL_HDEN_PTID).
`void`	`setCharacterCellHnum(int value)` Sets number property CharacterCellHnum (CHARACTER_CELL_HNUM_PTID).
`void`	`setCharacterCellVden(int value)` Sets number property CharacterCellVden (CHARACTER_CELL_VDEN_PTID).
`void`	`setCharacterCellVnum(int value)` Sets number property CharacterCellVnum (CHARACTER_CELL_VNUM_PTID).
`void`	`setClientInfo(java.lang.Object clientInfo)` Sets the client information.
`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`	`setDashStyle(int value)` Sets number property DashStyle (DASH_STYLE_PTID).
`void`	`setDisplayQuality(int value)` Sets number property DisplayQuality (DISPLAY_QUALITY_PTID).
`void`	`setDither(boolean value)` Sets boolean property Dither (DITHER_PTID).
`void`	`setDrawingHden(int value)` Sets number property DrawingHden (DRAWING_HDEN_PTID).
`void`	`setDrawingHnum(int value)` Sets number property DrawingHnum (DRAWING_HNUM_PTID).
`void`	`setDrawingWden(int value)` Sets number property DrawingWden (DRAWING_WDEN_PTID).
`void`	`setDrawingWnum(int value)` Sets number property DrawingWnum (DRAWING_WNUM_PTID).
`void`	`setEdgeBackColor(java.lang.String value)` Sets text property EdgeBackColor (EDGE_BACK_COLOR_PTID).
`void`	`setEdgeForegroundColor(java.lang.String value)` Sets text property EdgeForegroundColor (EDGE_FOREGROUND_COLOR_PTID).
`void`	`setEdgePattern(java.lang.String value)` Sets text property EdgePattern (EDGE_PATTERN_PTID).
`void`	`setEditorHeight(int value)` Sets number property EditorHeight (EDITOR_HEIGHT_PTID).
`void`	`setEditorWidth(int value)` Sets number property EditorWidth (EDITOR_WIDTH_PTID).
`void`	`setFillPattern(java.lang.String value)` Sets text property FillPattern (FILL_PATTERN_PTID).
`void`	`setFixedBoundingBox(boolean value)` Sets boolean property FixedBoundingBox (FIXED_BOUNDING_BOX_PTID).
`void`	`setFontName(java.lang.String value)` Sets text property FontName (FONT_NAME_PTID).
`void`	`setFontScaleable(boolean value)` Sets boolean property FontScaleable (FONT_SCALEABLE_PTID).
`void`	`setFontSize(int value)` Sets number property FontSize (FONT_SIZE_PTID).
`void`	`setFontSpacing(int value)` Sets number property FontSpacing (FONT_SPACING_PTID).
`void`	`setFontStyle(int value)` Sets number property FontStyle (FONT_STYLE_PTID).
`void`	`setFontWeight(int value)` Sets number property FontWeight (FONT_WEIGHT_PTID).
`void`	`setForegroundColor(java.lang.String value)` Sets text property ForegroundColor (FOREGROUND_COLOR_PTID).
`void`	`setFrameTitleAlign(int value)` Sets number property FrameTitleAlign (FRAME_TITLE_ALIGN_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`	`setGridFlag(boolean value)` Sets boolean property GridFlag (GRID_FLAG_PTID).
`void`	`setGridIntervalCnt(int value)` Sets number property GridIntervalCnt (GRID_INTERVAL_CNT_PTID).
`void`	`setGridSnapCnt(int value)` Sets number property GridSnapCnt (GRID_SNAP_CNT_PTID).
`void`	`setGridsnapFlag(boolean value)` Sets boolean property GridsnapFlag (GRIDSNAP_FLAG_PTID).
`void`	`setGridUnitCnt(int value)` Sets number property GridUnitCnt (GRID_UNIT_CNT_PTID).
`void`	`setIntegerProperty(int propertyTypeId, int propertyValue)` Sets the value of the specified object integer property.
`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`	`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`	`setPagebreakFlag(boolean value)` Sets boolean property PagebreakFlag (PAGEBREAK_FLAG_PTID).
`void`	`setPageCountSeq(boolean value)` Sets boolean property PageCountSeq (PAGE_COUNT_SEQ_PTID).
`void`	`setPersistentClientInfo(Blob val)` Sets persistent client info for this object.
`void`	`setPersistentClientInfo(java.io.Serializable obj)` Serializes any Java object which supports the Serializable interface to this object's Persistent Client Info.
`void`	`setResizableFlag(boolean value)` Sets boolean property ResizableFlag (RESIZABLE_FLAG_PTID).
`void`	`setRulerFlag(boolean value)` Sets boolean property RulerFlag (RULER_FLAG_PTID).
`void`	`setRulerGuideFlag(boolean value)` Sets boolean property RulerGuideFlag (RULER_GUIDE_FLAG_PTID).
`void`	`setRulerMajor(int value)` Sets number property RulerMajor (RULER_MAJOR_PTID).
`void`	`setRulerMinor(int value)` Sets number property RulerMinor (RULER_MINOR_PTID).
`void`	`setRulerUnit(int value)` Sets number property RulerUnit (RULER_UNIT_PTID).
`void`	`setShowCanvas(boolean value)` Sets boolean property ShowCanvas (SHOW_CANVAS_PTID).
`void`	`setShowView(boolean value)` Sets boolean property ShowView (SHOW_VIEW_PTID).
`void`	`setStatusLineFlag(boolean value)` Sets boolean property StatusLineFlag (STATUS_LINE_FLAG_PTID).
`void`	`setStringProperty(int propertyTypeId, java.lang.String propertyValue)` Sets the value of the specified string property for the object.
`void`	`setSubclassParent(JdapiObject parent)` Change the subclassing parent of the object referred.
`void`	`setToolpaletteFlag(boolean value)` Sets boolean property ToolpaletteFlag (TOOLPALETTE_FLAG_PTID).
`void`	`setVisualStateValid(boolean value)` Sets boolean property VisualStateValid (VISUAL_STATE_VALID_PTID).
`void`	`setWindowHeight(int value)` Sets number property WindowHeight (WINDOW_HEIGHT_PTID).
`void`	`setWindowWidth(int value)` Sets number property WindowWidth (WINDOW_WIDTH_PTID).
`void`	`setWindowXPosition(int value)` Sets number property WindowXPosition (WINDOW_X_POSITION_PTID).
`void`	`setWindowYPosition(int value)` Sets number property WindowYPosition (WINDOW_Y_POSITION_PTID).
`void`	`setWrapText(boolean value)` Sets boolean property WrapText (WRAP_TEXT_PTID).
`void`	`setZoomLevel(int value)` Sets number property ZoomLevel (ZOOM_LEVEL_PTID).
`java.lang.String`	`toString()` Converts and returns the object properties to string format.
`void`	`unsetSubclassParent()` Remove the subclassing parent of the object referred.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_pd2fob
```
protected transient long m_pd2fob
```
    This is the d2fob pointer in the C ifjapi60 for the object that is derived from this class.
  - m_clientInfo
```
protected transient java.lang.Object m_clientInfo
```
    Client info object held against this Forms object.
- Constructor Detail
  - VisualState
```
public VisualState(Canvas parent,
                   java.lang.String name)
```
    Constructor used to create VisualState objects in the context of a Canvas parent object.
    
    Parameters:
    
    parent - Parent object
    
    name - Name of the new object
  - VisualState
```
public VisualState(Canvas parent,
                   java.lang.String name,
                   VisualState base)
```
    Constructor used to create VisualState objects in the context of a Canvas parent object. The newly created object is derived from the 'base' object.
    
    Parameters:
    
    parent - Parent object
    
    name - Name of the new object
    
    base - VisualState object to derive from
  - VisualState
```
public VisualState(Canvas parent,
                   java.lang.String name,
                   PropertyClass base)
```
    Constructor used to create VisualState objects in the context of a Canvas parent object. The newly created object is derived from the 'base' PropertyClass.
    
    Parameters:
    
    parent - Parent object
    
    name - Name of the new object
    
    base - PropertyClass object to derive from
  - VisualState
```
protected VisualState(long pd2fvst)
```
    Protected constructor, used internally to create VisualState objects. This doesn't actually create a new VisualState, 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:
    
    pd2fvst - C pointer to Forms object
- Method Detail
  - getTypeId
```
public int getTypeId()
```
    Gets the HtmlForms object type ID.
    
    Specified by:
    
    getTypeId in interface JdapiObject
    
    Returns:
    
    X_OTID ID for this object type
    
    See Also:
    
    queryType
  - clone
```
public VisualState clone(Canvas parent,
                         java.lang.String newName)
```
    Creates a copy of the object as a child of 'parent'
    
    Parameters:
    
    parent - Parent object
    
    newName - Name of object that's being created
    
    Returns:
    
    Replicant object
  - find
```
public static VisualState find(Canvas parent,
                               java.lang.String name)
```
    Find an instance of VisualState that is a child of a Canvas.
    
    Parameters:
    
    parent - Parent object of object you wish to find
    
    name - Name of object you wish to find
    
    Returns:
    
    Object instance you are looking for, or null if none was found
  - getBackColor
```
public java.lang.String getBackColor()
```
    Get text property BackColor (BACK_COLOR_PTID).
    
    Returns:
    
    Value of property
  - setBackColor
```
public void setBackColor(java.lang.String value)
```
    Sets text property BackColor (BACK_COLOR_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getEdgeBackColor
```
public java.lang.String getEdgeBackColor()
```
    Get text property EdgeBackColor (EDGE_BACK_COLOR_PTID).
    
    Returns:
    
    Value of property
  - setEdgeBackColor
```
public void setEdgeBackColor(java.lang.String value)
```
    Sets text property EdgeBackColor (EDGE_BACK_COLOR_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getEdgeForegroundColor
```
public java.lang.String getEdgeForegroundColor()
```
    Get text property EdgeForegroundColor (EDGE_FOREGROUND_COLOR_PTID).
    
    Returns:
    
    Value of property
  - setEdgeForegroundColor
```
public void setEdgeForegroundColor(java.lang.String value)
```
    Sets text property EdgeForegroundColor (EDGE_FOREGROUND_COLOR_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getEdgePattern
```
public java.lang.String getEdgePattern()
```
    Get text property EdgePattern (EDGE_PATTERN_PTID).
    
    Returns:
    
    Value of property
  - setEdgePattern
```
public void setEdgePattern(java.lang.String value)
```
    Sets text property EdgePattern (EDGE_PATTERN_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getFillPattern
```
public java.lang.String getFillPattern()
```
    Get text property FillPattern (FILL_PATTERN_PTID).
    
    Returns:
    
    Value of property
  - setFillPattern
```
public void setFillPattern(java.lang.String value)
```
    Sets text property FillPattern (FILL_PATTERN_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getFontName
```
public java.lang.String getFontName()
```
    Get text property FontName (FONT_NAME_PTID).
    
    Returns:
    
    Value of property
  - setFontName
```
public void setFontName(java.lang.String value)
```
    Sets text property FontName (FONT_NAME_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getForegroundColor
```
public java.lang.String getForegroundColor()
```
    Get text property ForegroundColor (FOREGROUND_COLOR_PTID).
    
    Returns:
    
    Value of property
  - setForegroundColor
```
public void setForegroundColor(java.lang.String value)
```
    Sets text property ForegroundColor (FOREGROUND_COLOR_PTID).
    
    Parameters:
    
    value - Value to set property to
  - 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
  - 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
  - getCharacterCellHden
```
public int getCharacterCellHden()
```
    Get number property CharacterCellHden (CHARACTER_CELL_HDEN_PTID).
    
    Returns:
    
    Value of property
  - setCharacterCellHden
```
public void setCharacterCellHden(int value)
```
    Sets number property CharacterCellHden (CHARACTER_CELL_HDEN_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getCharacterCellHnum
```
public int getCharacterCellHnum()
```
    Get number property CharacterCellHnum (CHARACTER_CELL_HNUM_PTID).
    
    Returns:
    
    Value of property
  - setCharacterCellHnum
```
public void setCharacterCellHnum(int value)
```
    Sets number property CharacterCellHnum (CHARACTER_CELL_HNUM_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getCharacterCellVden
```
public int getCharacterCellVden()
```
    Get number property CharacterCellVden (CHARACTER_CELL_VDEN_PTID).
    
    Returns:
    
    Value of property
  - setCharacterCellVden
```
public void setCharacterCellVden(int value)
```
    Sets number property CharacterCellVden (CHARACTER_CELL_VDEN_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getCharacterCellVnum
```
public int getCharacterCellVnum()
```
    Get number property CharacterCellVnum (CHARACTER_CELL_VNUM_PTID).
    
    Returns:
    
    Value of property
  - setCharacterCellVnum
```
public void setCharacterCellVnum(int value)
```
    Sets number property CharacterCellVnum (CHARACTER_CELL_VNUM_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
  - 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
  - getDrawingHden
```
public int getDrawingHden()
```
    Get number property DrawingHden (DRAWING_HDEN_PTID).
    
    Returns:
    
    Value of property
  - setDrawingHden
```
public void setDrawingHden(int value)
```
    Sets number property DrawingHden (DRAWING_HDEN_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getDrawingHnum
```
public int getDrawingHnum()
```
    Get number property DrawingHnum (DRAWING_HNUM_PTID).
    
    Returns:
    
    Value of property
  - setDrawingHnum
```
public void setDrawingHnum(int value)
```
    Sets number property DrawingHnum (DRAWING_HNUM_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getDrawingWden
```
public int getDrawingWden()
```
    Get number property DrawingWden (DRAWING_WDEN_PTID).
    
    Returns:
    
    Value of property
  - setDrawingWden
```
public void setDrawingWden(int value)
```
    Sets number property DrawingWden (DRAWING_WDEN_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getDrawingWnum
```
public int getDrawingWnum()
```
    Get number property DrawingWnum (DRAWING_WNUM_PTID).
    
    Returns:
    
    Value of property
  - setDrawingWnum
```
public void setDrawingWnum(int value)
```
    Sets number property DrawingWnum (DRAWING_WNUM_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getEditorHeight
```
public int getEditorHeight()
```
    Get number property EditorHeight (EDITOR_HEIGHT_PTID).
    
    Returns:
    
    Value of property
  - setEditorHeight
```
public void setEditorHeight(int value)
```
    Sets number property EditorHeight (EDITOR_HEIGHT_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getEditorWidth
```
public int getEditorWidth()
```
    Get number property EditorWidth (EDITOR_WIDTH_PTID).
    
    Returns:
    
    Value of property
  - setEditorWidth
```
public void setEditorWidth(int value)
```
    Sets number property EditorWidth (EDITOR_WIDTH_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
  - 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
  - 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
  - getGridIntervalCnt
```
public int getGridIntervalCnt()
```
    Get number property GridIntervalCnt (GRID_INTERVAL_CNT_PTID).
    
    Returns:
    
    Value of property
  - setGridIntervalCnt
```
public void setGridIntervalCnt(int value)
```
    Sets number property GridIntervalCnt (GRID_INTERVAL_CNT_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getGridSnapCnt
```
public int getGridSnapCnt()
```
    Get number property GridSnapCnt (GRID_SNAP_CNT_PTID).
    
    Returns:
    
    Value of property
  - setGridSnapCnt
```
public void setGridSnapCnt(int value)
```
    Sets number property GridSnapCnt (GRID_SNAP_CNT_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getGridUnitCnt
```
public int getGridUnitCnt()
```
    Get number property GridUnitCnt (GRID_UNIT_CNT_PTID).
    
    Returns:
    
    Value of property
  - setGridUnitCnt
```
public void setGridUnitCnt(int value)
```
    Sets number property GridUnitCnt (GRID_UNIT_CNT_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
  - getRulerMajor
```
public int getRulerMajor()
```
    Get number property RulerMajor (RULER_MAJOR_PTID).
    
    Returns:
    
    Value of property
  - setRulerMajor
```
public void setRulerMajor(int value)
```
    Sets number property RulerMajor (RULER_MAJOR_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getRulerMinor
```
public int getRulerMinor()
```
    Get number property RulerMinor (RULER_MINOR_PTID).
    
    Returns:
    
    Value of property
  - setRulerMinor
```
public void setRulerMinor(int value)
```
    Sets number property RulerMinor (RULER_MINOR_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getRulerUnit
```
public int getRulerUnit()
```
    Get number property RulerUnit (RULER_UNIT_PTID).
    
    Returns:
    
    Value of property
  - setRulerUnit
```
public void setRulerUnit(int value)
```
    Sets number property RulerUnit (RULER_UNIT_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getWindowHeight
```
public int getWindowHeight()
```
    Get number property WindowHeight (WINDOW_HEIGHT_PTID).
    
    Returns:
    
    Value of property
  - setWindowHeight
```
public void setWindowHeight(int value)
```
    Sets number property WindowHeight (WINDOW_HEIGHT_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getWindowWidth
```
public int getWindowWidth()
```
    Get number property WindowWidth (WINDOW_WIDTH_PTID).
    
    Returns:
    
    Value of property
  - setWindowWidth
```
public void setWindowWidth(int value)
```
    Sets number property WindowWidth (WINDOW_WIDTH_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getWindowXPosition
```
public int getWindowXPosition()
```
    Get number property WindowXPosition (WINDOW_X_POSITION_PTID).
    
    Returns:
    
    Value of property
  - setWindowXPosition
```
public void setWindowXPosition(int value)
```
    Sets number property WindowXPosition (WINDOW_X_POSITION_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getWindowYPosition
```
public int getWindowYPosition()
```
    Get number property WindowYPosition (WINDOW_Y_POSITION_PTID).
    
    Returns:
    
    Value of property
  - setWindowYPosition
```
public void setWindowYPosition(int value)
```
    Sets number property WindowYPosition (WINDOW_Y_POSITION_PTID).
    
    Parameters:
    
    value - Value to set property to
  - getZoomLevel
```
public int getZoomLevel()
```
    Get number property ZoomLevel (ZOOM_LEVEL_PTID).
    
    Returns:
    
    Value of property
  - setZoomLevel
```
public void setZoomLevel(int value)
```
    Sets number property ZoomLevel (ZOOM_LEVEL_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
  - isCenterTracking
```
public boolean isCenterTracking()
```
    Get boolean property CenterTracking (CENTER_TRACKING_PTID).
    
    Returns:
    
    Value of property
  - setCenterTracking
```
public void setCenterTracking(boolean value)
```
    Sets boolean property CenterTracking (CENTER_TRACKING_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
  - 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
  - isGridFlag
```
public boolean isGridFlag()
```
    Get boolean property GridFlag (GRID_FLAG_PTID).
    
    Returns:
    
    Value of property
  - setGridFlag
```
public void setGridFlag(boolean value)
```
    Sets boolean property GridFlag (GRID_FLAG_PTID).
    
    Parameters:
    
    value - Value to set property to
  - isGridsnapFlag
```
public boolean isGridsnapFlag()
```
    Get boolean property GridsnapFlag (GRIDSNAP_FLAG_PTID).
    
    Returns:
    
    Value of property
  - setGridsnapFlag
```
public void setGridsnapFlag(boolean value)
```
    Sets boolean property GridsnapFlag (GRIDSNAP_FLAG_PTID).
    
    Parameters:
    
    value - Value to set property to
  - isPageCountSeq
```
public boolean isPageCountSeq()
```
    Get boolean property PageCountSeq (PAGE_COUNT_SEQ_PTID).
    
    Returns:
    
    Value of property
  - setPageCountSeq
```
public void setPageCountSeq(boolean value)
```
    Sets boolean property PageCountSeq (PAGE_COUNT_SEQ_PTID).
    
    Parameters:
    
    value - Value to set property to
  - isPagebreakFlag
```
public boolean isPagebreakFlag()
```
    Get boolean property PagebreakFlag (PAGEBREAK_FLAG_PTID).
    
    Returns:
    
    Value of property
  - setPagebreakFlag
```
public void setPagebreakFlag(boolean value)
```
    Sets boolean property PagebreakFlag (PAGEBREAK_FLAG_PTID).
    
    Parameters:
    
    value - Value to set property to
  - isResizableFlag
```
public boolean isResizableFlag()
```
    Get boolean property ResizableFlag (RESIZABLE_FLAG_PTID).
    
    Returns:
    
    Value of property
  - setResizableFlag
```
public void setResizableFlag(boolean value)
```
    Sets boolean property ResizableFlag (RESIZABLE_FLAG_PTID).
    
    Parameters:
    
    value - Value to set property to
  - isRulerFlag
```
public boolean isRulerFlag()
```
    Get boolean property RulerFlag (RULER_FLAG_PTID).
    
    Returns:
    
    Value of property
  - setRulerFlag
```
public void setRulerFlag(boolean value)
```
    Sets boolean property RulerFlag (RULER_FLAG_PTID).
    
    Parameters:
    
    value - Value to set property to
  - isRulerGuideFlag
```
public boolean isRulerGuideFlag()
```
    Get boolean property RulerGuideFlag (RULER_GUIDE_FLAG_PTID).
    
    Returns:
    
    Value of property
  - setRulerGuideFlag
```
public void setRulerGuideFlag(boolean value)
```
    Sets boolean property RulerGuideFlag (RULER_GUIDE_FLAG_PTID).
    
    Parameters:
    
    value - Value to set property to
  - isShowCanvas
```
public boolean isShowCanvas()
```
    Get boolean property ShowCanvas (SHOW_CANVAS_PTID).
    
    Returns:
    
    Value of property
  - setShowCanvas
```
public void setShowCanvas(boolean value)
```
    Sets boolean property ShowCanvas (SHOW_CANVAS_PTID).
    
    Parameters:
    
    value - Value to set property to
  - isShowView
```
public boolean isShowView()
```
    Get boolean property ShowView (SHOW_VIEW_PTID).
    
    Returns:
    
    Value of property
  - setShowView
```
public void setShowView(boolean value)
```
    Sets boolean property ShowView (SHOW_VIEW_PTID).
    
    Parameters:
    
    value - Value to set property to
  - isStatusLineFlag
```
public boolean isStatusLineFlag()
```
    Get boolean property StatusLineFlag (STATUS_LINE_FLAG_PTID).
    
    Returns:
    
    Value of property
  - setStatusLineFlag
```
public void setStatusLineFlag(boolean value)
```
    Sets boolean property StatusLineFlag (STATUS_LINE_FLAG_PTID).
    
    Parameters:
    
    value - Value to set property to
  - isToolpaletteFlag
```
public boolean isToolpaletteFlag()
```
    Get boolean property ToolpaletteFlag (TOOLPALETTE_FLAG_PTID).
    
    Returns:
    
    Value of property
  - setToolpaletteFlag
```
public void setToolpaletteFlag(boolean value)
```
    Sets boolean property ToolpaletteFlag (TOOLPALETTE_FLAG_PTID).
    
    Parameters:
    
    value - Value to set property to
  - isVisualStateValid
```
public boolean isVisualStateValid()
```
    Get boolean property VisualStateValid (VISUAL_STATE_VALID_PTID).
    
    Returns:
    
    Value of property
  - setVisualStateValid
```
public void setVisualStateValid(boolean value)
```
    Sets boolean property VisualStateValid (VISUAL_STATE_VALID_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
  - getObjectPointer
```
protected long getObjectPointer()
```
    Gets the Forms API pointer for this object.
    
    Returns:
    
    C pointer to the Forms object
  - queryType
```
public int queryType()
```
    Returns the FormAPI object type ID (x_OTID in JdapiTypes). This should always be the same value as returned for getTypeId. The difference between the two methods is that queryType calls down to the API itself; this ensures that the correct type is returned. Because this method calls down to the API, you might find it a little faster to use getTypeID instead.
    
    Specified by:
    
    queryType in interface JdapiObject
    
    Returns:
    
    x_OTID an object type ID as defined in JdapiTypes.
  - setClientInfo
```
public void setClientInfo(java.lang.Object clientInfo)
```
    Sets the client information. Since the clientInfo is a java.lang.Object, the client information can be anything you want to associate with the referred object. For example, you can create your own class, then pass it to this method. The referred object will retain a reference to the clientInfo.
    This client info object is not persistent and will be lost when the session ends.
    
    Specified by:
    
    setClientInfo in interface JdapiObject
    
    Parameters:
    
    clientInfo - client info to be associated with the object.
  - getClientInfo
```
public java.lang.Object getClientInfo()
```
    Returns the client info object associated with this Object. The type ID of the object returned is dependant on the type ID of the object that was set using setClientObject.
    
    Specified by:
    
    getClientInfo in interface JdapiObject
    
    Returns:
    
    the client info object associated with this object.
  - getPersistentClientInfoBlob
```
public Blob getPersistentClientInfoBlob()
```
    Returns the persistent client info Blob associated with this object.
    
    Specified by:
    
    getPersistentClientInfoBlob in interface JdapiObject
    
    Returns:
    
    Blob containing client info.
  - getPersistentClientInfoObject
```
public java.lang.Object getPersistentClientInfoObject()
```
    Returns the persistent client info Java object associated with this object.
    
    Specified by:
    
    getPersistentClientInfoObject in interface JdapiObject
    
    Returns:
    
    java.lang.Object serialized into the Forms object.
  - setPersistentClientInfo
```
public void setPersistentClientInfo(Blob val)
```
    Sets persistent client info for this object.
    Like the non-persistent client info methods, the client info can be any information that you want to save with the form. Unlike the non-persistent client info methods, the persistent info is saved as part of the form and will not be lost when the session is ended.
    
    Specified by:
    
    setPersistentClientInfo in interface JdapiObject
    
    Parameters:
    
    val - a Blob object containing client info.
  - setPersistentClientInfo
```
public void setPersistentClientInfo(java.io.Serializable obj)
```
    Serializes any Java object which supports the Serializable interface to this object's Persistent Client Info.
    Like the non-persistent client info methods, the client info can be any information that you want to save with the form. Unlike the non-persistent client info methods, the persistent info is saved as part of the form and will not be lost when the session is ended.
    
    Specified by:
    
    setPersistentClientInfo in interface JdapiObject
    
    Parameters:
    
    obj - any Serializable object containing client info.
  - equals
```
public boolean equals(JdapiObject obj)
```
    Compares two objects and determines if they are equal.
    
    Specified by:
    
    equals in interface JdapiObject
    
    Parameters:
    
    obj - object to be compared.
    
    Returns:
    
    true if the two objects are equal; returns false if they are not equal.
  - clone
```
public JdapiObject clone(JdapiObject parent,
                         java.lang.String newName)
```
    Creates a clone of the specified object, creating a new object with the given name and owner. For example, given a Block in Form A, you can clone it into Form B by passing Form B in the parent parameter, and specifying a new name for the block in the newName parameter.
    The new object is the same as the original object in that it has the same property values. However, subclassing information is discarded, and the inherited property values "flattened" into local values in the new object.
    It is your reponsibility to pass in an appropriate parent object. If you do not do this, you will probably get a JdapiException runtime exception. If possible, use the type safe clone method that is provided on each Forms object class.
    
    Specified by:
    
    clone in interface JdapiObject
    
    Parameters:
    
    parent - owner of the new object.
    
    newName - name of the new object.
    
    Returns:
    
    the clone of the object.
  - changeOwner
```
public void changeOwner(JdapiObject newOwner)
```
    Assigns a new owner to the referred object. This method will cause any previous owner to relinquish its ownership of the referred object.
    Set newOwner to null if you want the object to have no owner.
    The only restriction on this method is that the new owner must be in the same module as the referred object. If you attempt to assign a new owner that is in a different module, then a JdapiException will be thrown.
    Note: If you want to assign the object to a new owner in a different module, then you will have to clone or subclass the object.
    
    Specified by:
    
    changeOwner in interface JdapiObject
    
    Parameters:
    
    newOwner - the new owner of referred object; specify null if you want the object to have no owner.
    
    Throws:
    
    JdapiException - if newOwner is in a different module.
  - toString
```
public java.lang.String toString()
```
    Converts and returns the object properties to string format. This is useful for debugging purposes. The string is in the format: NAME(CLASSNAME, pointer: D2FOB*, context D2FCTX*)
    
    Specified by:
    
    toString in interface JdapiObject
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String representation of the object
  - clearObjectPointer
```
protected void clearObjectPointer()
```
    Used internally to flag this object as an invalid object.
  - isValidFormsObject
```
public boolean isValidFormsObject()
```
    Description copied from interface: JdapiObject
    
    Determines whether this Java instance references a valid Forms object.
    For example, assume that you have a reference to a block. If you call destroy() on its owning module, then the module and all of its blocks should be deleted from memory. The reference that you have no longer refers to a valid Forms object. A call to isValidFormsObject() on the block should return false.
    
    Specified by:
    
    isValidFormsObject in interface JdapiObject
    
    Returns:
    
    true if the instance references a valid forms object; false otherwise.
  - destroy
```
public void destroy()
```
    Destroys the object - this removes the object from it's context. The JNI level is responsible for removing this object from the context cache, so we don't need to do that in here.
    
    Specified by:
    
    destroy in interface JdapiObject
  - move
```
public void move(JdapiObject next)
```
    Reorders an object with respect to its siblings in the collection it belongs to. This is similar to using drag and drop in Form Builder to move a block in a list. This method represents a way to do the same thing programmatically. For example, if you want a block appear immediately before Block5 in a list, you pass the object representing Block5 as the nextObject argument.
    Pass null to this method to move the object to the end of the list. If the specified object and the next_object do not share the same owner, or do not have the same type, the method throws an exception.
    You cannot use this method to move objects between parents. For example, it cannot be used to move an Item from one Block to another. If you want to move an object from one parent to another you will have to do something like:
```
   // e.g. to move 'itmA' to be positioned before 'itmB' in block
   // 'blkB' (when 'itmA' is in another block)

   // copy itmA into a new parent (blkB) using same name
   Item newItmA = itmA.clone(blkB, itmA.getName());
   newItmA.move(itmB);   // move new item relative to itmB
   itmA.destroy();       // delete original object
   itmA = newItmA;
 
```
    Specified by:
    
    move in interface JdapiObject
    
    Parameters:
    
    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 interface JdapiObject
    
    Parameters:
    
    propertyTypeId - property type ID for which a boolean value is returned.
    
    Returns:
    
    the boolean property value.
  - getStringProperty
```
public java.lang.String getStringProperty(int propertyTypeId)
```
    Retrieves a string property from the referred object.
    
    Specified by:
    
    getStringProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - property type ID for which a string value is returned.
    
    Returns:
    
    the string property value.
  - getIntegerProperty
```
public int getIntegerProperty(int propertyTypeId)
```
    Retrieves an integer property from the referred object. For example:
```
   ...
    if(propClass.hasProperty(propNumber) && propClass.allowGet(propNumber))
    {
      int propValue = propClass.getIntegerProperty(propNum);
    } 
    ...
 
```
    Specified by:
    
    getIntegerProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - property type ID for which an integer value is returned.
    
    Returns:
    
    the integer property value.
  - getStringIDProperty
```
public int getStringIDProperty(int propertyTypeId)
```
    Retrieves a special String ID (integer) property from the referred object.
    This method is intended for use with the TranslationTable object only. For a given property ID it retrieves the integer that indexes the string property in the table for the current language.
    
    Specified by:
    
    getStringIDProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - property type ID for which a String ID value is returned.
    
    Returns:
    
    the integer String ID property value.
  - getPropertyValueName
```
public java.lang.String getPropertyValueName(int propertyTypeId,
                                             int val)
```
    Description copied from interface: JdapiObject
    
    Gets the string representation of a given property's value.
    
    Specified by:
    
    getPropertyValueName in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - Property number
    
    val - Value of property
    
    Returns:
    
    String representation
  - getIntegerPropertyString
```
public java.lang.String getIntegerPropertyString(int propertyTypeId)
```
    Description copied from interface: JdapiObject
    
    Gets a numeric (long) property value's text representation.
    
    Specified by:
    
    getIntegerPropertyString in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - Number identifying the property
    
    Returns:
    
    Property's text representation
  - getObjProp
```
protected long getObjProp(int propertyTypeId)
```
    Internal method used to get an object property value. This only really gets the C pointer to the Forms object. You must then use the ContextCache to lookup/instantiate the Java representation of the object.
    
    Parameters:
    
    propertyTypeId - Number identifying the property
    
    Returns:
    
    Property's value
    
    See Also:
    
    ContextCache, getObjectProperty(int)
  - getObjectProperty
```
public JdapiObject getObjectProperty(int propertyTypeId)
```
    Description copied from interface: JdapiObject
    
    Retrieves a JdapiObject property from the referred object. For example, if you pass the integer propertyTypeId for an Item in a Block to this method, it returns the Item.
    
    Specified by:
    
    getObjectProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - property type ID for which a JdapiObject value is returned.
    
    Returns:
    
    the JdapiObject property value.
  - getChildObjectProperty
```
public JdapiIterator getChildObjectProperty(int propertyTypeId)
```
    Description copied from interface: JdapiObject
    Retrieves child objects for a given property value. Implicit in this method is the idea of an ownership relationship between objects. Items are clearly owned by a Block. If you delete the Block, then its Items are deleted. On the other hand, Items can appear on a Canvas. If you delete the Canvas, however, the Items are not deleted. Thus, the method returns an iterator over Items if it is passed a Block. In contrast, if it is passed a Canvas, it should not return an iterator over Items.
    For example:
```
      ...
      // get the actual values for the current child object type, 
      // for example, get the Items on a Block 
      iter = jo.getChildObjectProperty(prop.getPropertyId());  
      ...
 
```
    Note, it should be (slightly) faster to call the specific method on the object, for example getBlocks() on the FormModule, as it involves fewer API calls. However, getChildObjectProperty should be sufficient if you only have a propertyTypeId available.
    
    This method also differs from the direct accessors in that null is returned if there are no objects, not an empty iterator.
    Specified by:
    
    getChildObjectProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - number identifying the child object property.
    
    Returns:
    
    Iterator for child objects, can return null if there are no child objects.
  - setBooleanProperty
```
public void setBooleanProperty(int propertyTypeId,
                               boolean propertyValue)
```
    Description copied from interface: JdapiObject
    
    Sets the value of the specified boolean property belonging to the referred object.
    
    Specified by:
    
    setBooleanProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - property type ID of the property for which you want to set the boolean value.
    
    propertyValue - the boolean value for the property.
  - setStringProperty
```
public void setStringProperty(int propertyTypeId,
                              java.lang.String propertyValue)
```
    Description copied from interface: JdapiObject
    
    Sets the value of the specified string property for the object.
    
    Specified by:
    
    setStringProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - property type ID of the property for which you want to set the string value.
    
    propertyValue - the string value for the property.
  - setIntegerProperty
```
public void setIntegerProperty(int propertyTypeId,
                               int propertyValue)
```
    Sets the value of the specified object integer property.
    
    Specified by:
    
    setIntegerProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - property type id for which we set the integer value.
    
    propertyValue - the integer property value in property.
  - setObjProp
```
protected void setObjProp(int propertyTypeId,
                          long val)
```
    Internal method used to set an object property. This sets the object property by the C pointer to the object you want to set.
    
    Parameters:
    
    propertyTypeId - Number identifying the property
    
    val - Value to set the property to
    
    See Also:
    
    setObjectProperty(int, oracle.forms.jdapi.JdapiObject)
  - setObjectProperty
```
public void setObjectProperty(int propertyTypeId,
                              JdapiObject propertyValue)
```
    Sets the value of the specified object object property value.
    
    Specified by:
    
    setObjectProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - property type id for which we set the object property value.
    
    propertyValue - the object property value in property.
  - hasProperty
```
public boolean hasProperty(int propertyTypeId)
```
    Checks if the object has a given property.
    
    Specified by:
    
    hasProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - Number identifying the property
    
    Returns:
    
    'true' if the object has that property, 'false' otherwise
  - inheritProperty
```
public void inheritProperty(int propertyTypeId)
```
    Resets a property to it's default value (confusing name eh?). What it's really doing is setting the property to it's base classes value - i.e. whatever it's subclassed from. If the object is not subclassed from anything, then this is the default value.
    
    Specified by:
    
    inheritProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - Number that identified the property
  - hasInheritedProperty
```
public boolean hasInheritedProperty(int propertyTypeId)
```
    Checks if a property is inherited.
    
    Specified by:
    
    hasInheritedProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - Number that identified the property
    
    Returns:
    
    'true' if property is inherited
  - hasOverriddenProperty
```
public boolean hasOverriddenProperty(int propertyTypeId)
```
    Determine whether the object referred has a property of the given type id with an overridden value.
    
    Specified by:
    
    hasOverriddenProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - The type id of the property to be queried.
    
    Returns:
    
    TRUE if the object's property has overridden value, else FALSE.
  - hasDefaultedProperty
```
public boolean hasDefaultedProperty(int propertyTypeId)
```
    Checks if a property is set to it's default value.
    
    Specified by:
    
    hasDefaultedProperty in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - Number that identified the property
    
    Returns:
    
    'true' if the property is set to the default value
  - getPropertyState
```
public int getPropertyState(int propertyTypeId)
```
    Returns the current state of the specified property.
    A property can be in one of the 5 states:
    PROPERTY_STATE_UNKNOWN = 0;
    PROPERTY_DEFAULT_VALUE = 1;
    PROPERTY_OVERRIDDEN_DEFAULT_VALUE = 2;
    PROPERTY_INHERITED_VALUE = 3;
    PROPERTY_OVERRIDDEN_INHERITED_VALUE = 3;
    
    Specified by:
    
    getPropertyState in interface JdapiObject
    
    Parameters:
    
    propertyTypeId - The type id of the property.
    
    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 interface JdapiObject
    
    Returns:
    
    'true' if the object is subclassed, 'false' otherwise
  - getSubclassParent
```
public JdapiObject getSubclassParent()
```
    Get Source (SOURCE_PTID) object property, i.e. the object this object subclassed from. This is also implemented on derived classed with this property as getSource().
    
    Specified by:
    
    getSubclassParent in interface JdapiObject
    
    Returns:
    
    Value of property downcast to a BaseFormsObject (null if none of object does not have this property)
  - setSubclassParent
```
public void setSubclassParent(JdapiObject parent)
```
    Change the subclassing parent of the object referred.
    The metadata associated with each object describes the types of objects that can become its subclassing parent. If the subclassing metadata associated with the refrred object doesn't indicate the objects of the given parent's type are allowed, then this method will throw an exception.
    
    Specified by:
    
    setSubclassParent in interface JdapiObject
    
    Parameters:
    
    parent - The parent object. If this is null, the child the referred object will become an orphan. This is the way to unset the subclassing parent of an object.
  - 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
```
public JdapiObject createSubclassedChild(JdapiObject childOwner,
                                         java.lang.String childName)
```
    Subclass the referred object. The child will be owned by the referred object specified.
    
    Specified by:
    
    createSubclassedChild in interface JdapiObject
    
    Parameters:
    
    childOwner - The object that will own the newly created subclassed child object.
    
    childName - The name to be given to the newly created child.
    
    Returns:
    
    the subclassed object.
  - reattach
```
public void reattach()
```
    Reattaches subclassed object. You must call this method if you manipulate any of the following properties of a Forms object: PAR_MODULE_PTID, PAR_NAM_PTID, PAR_SL1OBJ_NAM_PTID, PAR_MODTYP_PTID, PAR_TYP_PTID, PARSL1OBJ_TYP_PTID This is only if you are manipulating these low level subclassing properties.
    
    Specified by:
    
    reattach in interface JdapiObject
  - getModule
```
public JdapiObject getModule()
```
    Get Module (MODULE_PTID) object property.
    
    Specified by:
    
    getModule in interface JdapiObject
    
    Returns:
    
    Value of property downcast to a JdapiObject (null if none)
  - getOwner
```
public JdapiObject getOwner()
```
    Get Owner (OWNER_PTID) object property.
    
    Specified by:
    
    getOwner in interface JdapiObject
    
    Returns:
    
    Value of property downcast to a JdapiObject (null if none)
  - getOwnedObjects
```
public JdapiIterator getOwnedObjects()
```
    Get the object instances owned by this particular object.
    
    Specified by:
    
    getOwnedObjects in interface JdapiObject
    
    Returns:
    
    Iterator of JdapiObjects
  - getName
```
public java.lang.String getName()
```
    Get the Name property (NAME_PTID) of this object. Not all Forms objects have names and if this is the case then the string "" is returned.
    
    Specified by:
    
    getName in interface JdapiObject
    
    Returns:
    
    Name of object
  - getClassName
```
public java.lang.String getClassName()
```
    Gets the class name of the object. This is useful if you want to refer to the name of the Forms object in some output but don't want the Java package details.
    
    Specified by:
    
    getClassName in interface JdapiObject
    
    Returns:
    
    Name of "class" of Forms object
  - getQualifiedName
```
public java.lang.String getQualifiedName(boolean includeModule)
```
    Gets a fully qualified name for the object in the format of: MODULE.OBJECT.CHILD.CHILD... i.e. '.' separates the objects names from the current object back upto the module.
    
    Specified by:
    
    getQualifiedName in interface JdapiObject
    
    Parameters:
    
    includeModule - Include the module name
  - getJdapiMetaObject
```
public JdapiMetaObject getJdapiMetaObject()
```
    Gets the metadata object for the specified object.
    
    Specified by:
    
    getJdapiMetaObject in interface JdapiObject
    
    Returns:
    
    the metadata object for the specified object.
  - getMetaProperties
```
public JdapiIterator getMetaProperties()
```
    Return an iterator over the meta properties in object referred.
    The various property type ids and the object-property mapping are defined by the specific implementation in the respective Constants file.
    
    Specified by:
    
    getMetaProperties in interface JdapiObject
    
    Returns:
    
    an enumeration of the specified object meta properties.

Class VisualState

Field Summary

Fields inherited from interface oracle.forms.jdapi.JdapiObject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_pd2fob

m_clientInfo

Constructor Detail

VisualState

VisualState

VisualState

VisualState

Method Detail

getTypeId

clone

find

getBackColor

setBackColor

getEdgeBackColor

setEdgeBackColor

getEdgeForegroundColor

setEdgeForegroundColor

getEdgePattern

setEdgePattern

getFillPattern

setFillPattern

getFontName

setFontName

getForegroundColor

setForegroundColor

getArrowStyle

setArrowStyle

getCapStyle

setCapStyle

getCharacterCellHden

setCharacterCellHden

getCharacterCellHnum

setCharacterCellHnum

getCharacterCellVden

setCharacterCellVden

getCharacterCellVnum

setCharacterCellVnum

getCornerRadiusX

setCornerRadiusX

getCornerRadiusY

setCornerRadiusY

getDashStyle

setDashStyle

getDisplayQuality

setDisplayQuality

getDrawingHden

setDrawingHden

getDrawingHnum

setDrawingHnum

getDrawingWden

setDrawingWden

getDrawingWnum

setDrawingWnum

getEditorHeight

setEditorHeight

getEditorWidth

setEditorWidth

getFontSize

setFontSize

getFontSpacing

setFontSpacing

getFontStyle

setFontStyle

getFontWeight

setFontWeight

getFrameTitleAlign

setFrameTitleAlign

getFrameTitleOffset

setFrameTitleOffset

getFrameTitleSpacing

setFrameTitleSpacing

getGridIntervalCnt

setGridIntervalCnt