public class Canvas extends BaseFormsObject
In some cases, using methods on this class may result in a
JdapiIllegalStateException being thrown. When this happens, you are using
an object that refers to a Forms object that has been deleted - your
reference is no longer valid. You can check if an instance of this
class is valid by using the isValidFormsObject()
method.
If you code correctly, this should not happen. It will tend to happen
if you keep references (for extended periods) to Forms objects rather
than look them up dynamically. Of course you will only have this
problem if you destroy Forms objects.
BaseAPI
m_clientInfo, m_pd2fob
PROPERTY_DEFAULT_VALUE, PROPERTY_INHERITED_VALUE, PROPERTY_OVERRIDDEN_DEFAULT_VALUE, PROPERTY_OVERRIDDEN_INHERITED_VALUE, PROPERTY_STATE_UNKNOWN
Modifier | Constructor and Description |
---|---|
|
Canvas(FormModule parent,
java.lang.String name)
Constructor used to create Canvas objects in the context of
a FormModule parent object.
|
|
Canvas(FormModule parent,
java.lang.String name,
Canvas base)
Constructor used to create Canvas objects in the context of a
FormModule parent object.
|
|
Canvas(FormModule parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Canvas objects in the context of a
FormModule parent object.
|
protected |
Canvas(long pd2fcnv)
Protected constructor, used internally to create Canvas
objects.
|
|
Canvas(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name)
Constructor used to create Canvas objects in the context of
an ObjectLibraryTab parent object.
|
|
Canvas(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
Canvas base)
Constructor used to create Canvas objects in the context of an
ObjectLibraryTab parent object.
|
|
Canvas(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
PropertyClass base)
Constructor used to create Canvas objects in the context of an
ObjectLibraryTab parent object.
|
Modifier and Type | Method and Description |
---|---|
Canvas |
clone(FormModule parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
Canvas |
clone(ObjectLibraryTab parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
static Canvas |
find(FormModule parent,
java.lang.String name)
Find an instance of Canvas that is a child of a FormModule.
|
static Canvas |
find(ObjectLibraryTab parent,
java.lang.String name)
Find an instance of Canvas that is a child of a ObjectLibraryTab.
|
java.lang.String |
getBackColor()
Get text property BackColor (BACK_COLOR_PTID).
|
int |
getBevel()
Get number property Bevel (BEVEL_PTID).
|
int |
getCanvasType()
Get number property CanvasType (CANVAS_TYPE_PTID).
|
java.lang.String |
getComment()
Get text property Comment (COMMENT_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 |
getGradientStart()
Get number property GradientStart (GRADIENT_START_PTID).
|
JdapiIterator |
getGraphicses()
Accessor for child Graphics objects (GRAPHIC_PTID).
|
int |
getHeight()
Get number property Height (HEIGHT_PTID).
|
java.lang.String |
getHelpBookTopic()
Get text property HelpBookTopic (HELP_BOOK_TOPIC_PTID).
|
int |
getLanguageDirection()
Get number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
|
JdapiObject |
getModule()
Get object property Module (MODULE_PTID).
|
java.lang.String |
getName()
Get text property Name (NAME_PTID).
|
JdapiObject |
getOwner()
Get object property Owner (OWNER_PTID).
|
java.lang.String |
getParentFilename()
Get text property ParentFilename (PARENT_FILENAME_PTID).
|
java.lang.String |
getParentFilepath()
Get text property ParentFilepath (PARENT_FILEPATH_PTID).
|
java.lang.String |
getParentModule()
Get text property ParentModule (PARENT_MODULE_PTID).
|
int |
getParentModuleType()
Get number property ParentModuleType (PARENT_MODULETYPE_PTID).
|
java.lang.String |
getParentName()
Get text property ParentName (PARENT_NAME_PTID).
|
int |
getParentType()
Get number property ParentType (PARENT_TYPE_PTID).
|
int |
getPersistentClientInfoLength()
Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
|
java.lang.String |
getPopupMenuName()
Get text property PopupMenuName (POPUP_MENU_NAME_PTID).
|
Menu |
getPopupMenuObject()
Get object property PopupMenuObject (POPUP_MENU_OBJECT_PTID).
|
JdapiObject |
getSource()
Get object property Source (SOURCE_PTID).
|
int |
getTabActionStyle()
Get number property TabActionStyle (TAB_ACTION_STYLE_PTID).
|
int |
getTabAttachmentEdge()
Get number property TabAttachmentEdge (TAB_ATTACHMENT_EDGE_PTID).
|
JdapiIterator |
getTabPages()
Accessor for child TabPage objects (TAB_PAGE_PTID).
|
int |
getTabStyle()
Get number property TabStyle (TAB_STYLE_PTID).
|
int |
getTabWidthStyle()
Get number property TabWidthStyle (TAB_WIDTH_STYLE_PTID).
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
int |
getViewportHeight()
Get number property ViewportHeight (VIEWPORT_HEIGHT_PTID).
|
int |
getViewportWidth()
Get number property ViewportWidth (VIEWPORT_WIDTH_PTID).
|
int |
getViewportXPosition()
Get number property ViewportXPosition (VIEWPORT_X_POSITION_PTID).
|
int |
getViewportXPositionOnCanvas()
Get number property ViewportXPositionOnCanvas (VIEWPORT_X_POSITION_ON_CANVAS_PTID).
|
int |
getViewportYPosition()
Get number property ViewportYPosition (VIEWPORT_Y_POSITION_PTID).
|
int |
getViewportYPositionOnCanvas()
Get number property ViewportYPositionOnCanvas (VIEWPORT_Y_POSITION_ON_CANVAS_PTID).
|
java.lang.String |
getVisualAttributeName()
Get text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).
|
VisualAttribute |
getVisualAttributeObject()
Get object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).
|
JdapiIterator |
getVisualStates()
Accessor for child VisualState objects (VISUAL_STATE_PTID).
|
int |
getWidth()
Get number property Width (WIDTH_PTID).
|
java.lang.String |
getWindowName()
Get text property WindowName (WINDOW_NAME_PTID).
|
Window |
getWindowObject()
Get object property WindowObject (WINDOW_OBJECT_PTID).
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
|
boolean |
isDisplayViewport()
Get boolean property DisplayViewport (DISPLAY_VIEWPORT_PTID).
|
boolean |
isRaiseOnEnter()
Get boolean property RaiseOnEnter (RAISE_ON_ENTER_PTID).
|
boolean |
isShowHorizontalScrollbar()
Get boolean property ShowHorizontalScrollbar (SHOW_HORIZONTAL_SCROLLBAR_PTID).
|
boolean |
isShowVerticalScrollbar()
Get boolean property ShowVerticalScrollbar (SHOW_VERTICAL_SCROLLBAR_PTID).
|
boolean |
isSubclassObjectGroup()
Get boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).
|
boolean |
isVisible()
Get boolean property Visible (VISIBLE_PTID).
|
void |
setBackColor(java.lang.String value)
Sets text property BackColor (BACK_COLOR_PTID).
|
void |
setBevel(int value)
Sets number property Bevel (BEVEL_PTID).
|
void |
setCanvasType(int value)
Sets number property CanvasType (CANVAS_TYPE_PTID).
|
void |
setComment(java.lang.String value)
Sets text property Comment (COMMENT_PTID).
|
void |
setDirtyInfo(boolean value)
Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
|
void |
setDisplayViewport(boolean value)
Sets boolean property DisplayViewport (DISPLAY_VIEWPORT_PTID).
|
void |
setFillPattern(java.lang.String value)
Sets text property FillPattern (FILL_PATTERN_PTID).
|
void |
setFontName(java.lang.String value)
Sets text property FontName (FONT_NAME_PTID).
|
void |
setFontSize(int value)
Sets number property FontSize (FONT_SIZE_PTID).
|
void |
setFontSpacing(int value)
Sets number property FontSpacing (FONT_SPACING_PTID).
|
void |
setFontStyle(int value)
Sets number property FontStyle (FONT_STYLE_PTID).
|
void |
setFontWeight(int value)
Sets number property FontWeight (FONT_WEIGHT_PTID).
|
void |
setForegroundColor(java.lang.String value)
Sets text property ForegroundColor (FOREGROUND_COLOR_PTID).
|
void |
setGradientStart(int value)
Sets number property GradientStart (GRADIENT_START_PTID).
|
void |
setHeight(int value)
Sets number property Height (HEIGHT_PTID).
|
void |
setHelpBookTopic(java.lang.String value)
Sets text property HelpBookTopic (HELP_BOOK_TOPIC_PTID).
|
void |
setLanguageDirection(int value)
Sets number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
|
void |
setName(java.lang.String value)
Sets text property Name (NAME_PTID).
|
void |
setParentFilename(java.lang.String value)
Sets text property ParentFilename (PARENT_FILENAME_PTID).
|
void |
setParentFilepath(java.lang.String value)
Sets text property ParentFilepath (PARENT_FILEPATH_PTID).
|
void |
setParentModule(java.lang.String value)
Sets text property ParentModule (PARENT_MODULE_PTID).
|
void |
setParentModuleType(int value)
Sets number property ParentModuleType (PARENT_MODULETYPE_PTID).
|
void |
setParentName(java.lang.String value)
Sets text property ParentName (PARENT_NAME_PTID).
|
void |
setParentType(int value)
Sets number property ParentType (PARENT_TYPE_PTID).
|
void |
setPersistentClientInfoLength(int value)
Sets number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
|
void |
setPopupMenuName(java.lang.String value)
Sets text property PopupMenuName (POPUP_MENU_NAME_PTID).
|
void |
setPopupMenuObject(Menu value)
Set object property PopupMenuObject (POPUP_MENU_OBJECT_PTID).
|
void |
setRaiseOnEnter(boolean value)
Sets boolean property RaiseOnEnter (RAISE_ON_ENTER_PTID).
|
void |
setShowHorizontalScrollbar(boolean value)
Sets boolean property ShowHorizontalScrollbar (SHOW_HORIZONTAL_SCROLLBAR_PTID).
|
void |
setShowVerticalScrollbar(boolean value)
Sets boolean property ShowVerticalScrollbar (SHOW_VERTICAL_SCROLLBAR_PTID).
|
void |
setSubclassObjectGroup(boolean value)
Sets boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).
|
void |
setTabActionStyle(int value)
Sets number property TabActionStyle (TAB_ACTION_STYLE_PTID).
|
void |
setTabAttachmentEdge(int value)
Sets number property TabAttachmentEdge (TAB_ATTACHMENT_EDGE_PTID).
|
void |
setTabStyle(int value)
Sets number property TabStyle (TAB_STYLE_PTID).
|
void |
setTabWidthStyle(int value)
Sets number property TabWidthStyle (TAB_WIDTH_STYLE_PTID).
|
void |
setViewportHeight(int value)
Sets number property ViewportHeight (VIEWPORT_HEIGHT_PTID).
|
void |
setViewportWidth(int value)
Sets number property ViewportWidth (VIEWPORT_WIDTH_PTID).
|
void |
setViewportXPosition(int value)
Sets number property ViewportXPosition (VIEWPORT_X_POSITION_PTID).
|
void |
setViewportXPositionOnCanvas(int value)
Sets number property ViewportXPositionOnCanvas (VIEWPORT_X_POSITION_ON_CANVAS_PTID).
|
void |
setViewportYPosition(int value)
Sets number property ViewportYPosition (VIEWPORT_Y_POSITION_PTID).
|
void |
setViewportYPositionOnCanvas(int value)
Sets number property ViewportYPositionOnCanvas (VIEWPORT_Y_POSITION_ON_CANVAS_PTID).
|
void |
setVisible(boolean value)
Sets boolean property Visible (VISIBLE_PTID).
|
void |
setVisualAttributeName(java.lang.String value)
Sets text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).
|
void |
setVisualAttributeObject(VisualAttribute value)
Set object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).
|
void |
setWidth(int value)
Sets number property Width (WIDTH_PTID).
|
void |
setWindowName(java.lang.String value)
Sets text property WindowName (WINDOW_NAME_PTID).
|
void |
setWindowObject(Window value)
Set object property WindowObject (WINDOW_OBJECT_PTID).
|
changeOwner, clearObjectPointer, clone, createSubclassedChild, destroy, equals, getBooleanProperty, getChildObjectProperty, getClassName, getClientInfo, getIntegerProperty, getIntegerPropertyString, getJdapiMetaObject, getMetaProperties, getObjectPointer, getObjectProperty, getObjProp, getOwnedObjects, getPersistentClientInfoBlob, getPersistentClientInfoObject, getPropertyState, getPropertyValueName, getQualifiedName, getStringIDProperty, getStringProperty, getSubclassParent, hasDefaultedProperty, hasInheritedProperty, hasOverriddenProperty, hasProperty, inheritProperty, isSubclassed, isValidFormsObject, move, queryType, reattach, setBooleanProperty, setClientInfo, setIntegerProperty, setObjectProperty, setObjProp, setPersistentClientInfo, setPersistentClientInfo, setStringProperty, setSubclassParent, toString, unsetSubclassParent
public Canvas(FormModule parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Canvas(FormModule parent, java.lang.String name, Canvas base)
parent
- Parent objectname
- Name of the new objectbase
- Canvas object to derive frompublic Canvas(FormModule parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Canvas(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectpublic Canvas(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, Canvas base)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectbase
- Canvas object to derive frompublic Canvas(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, PropertyClass base)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectbase
- PropertyClass object to derive fromprotected Canvas(long pd2fcnv)
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);
pd2fcnv
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public Canvas clone(FormModule parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Canvas clone(ObjectLibraryTab parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static Canvas find(FormModule parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Canvas find(ObjectLibraryTab parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic java.lang.String getBackColor()
public void setBackColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getComment()
public void setComment(java.lang.String value)
value
- Value to set property topublic java.lang.String getFillPattern()
public void setFillPattern(java.lang.String value)
value
- Value to set property topublic java.lang.String getFontName()
public void setFontName(java.lang.String value)
value
- Value to set property topublic java.lang.String getForegroundColor()
public void setForegroundColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getHelpBookTopic()
public void setHelpBookTopic(java.lang.String value)
value
- Value to set property topublic java.lang.String getName()
getName
in interface JdapiObject
getName
in class BaseFormsObject
public void setName(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentFilename()
public void setParentFilename(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentFilepath()
public void setParentFilepath(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentModule()
public void setParentModule(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentName()
public void setParentName(java.lang.String value)
value
- Value to set property topublic java.lang.String getPopupMenuName()
public void setPopupMenuName(java.lang.String value)
value
- Value to set property topublic java.lang.String getVisualAttributeName()
public void setVisualAttributeName(java.lang.String value)
value
- Value to set property topublic java.lang.String getWindowName()
public void setWindowName(java.lang.String value)
value
- Value to set property topublic int getBevel()
public void setBevel(int value)
value
- Value to set property topublic int getCanvasType()
public void setCanvasType(int value)
value
- Value to set property topublic int getFontSize()
public void setFontSize(int value)
value
- Value to set property topublic int getFontSpacing()
public void setFontSpacing(int value)
value
- Value to set property topublic int getFontStyle()
public void setFontStyle(int value)
value
- Value to set property topublic int getFontWeight()
public void setFontWeight(int value)
value
- Value to set property topublic int getGradientStart()
public void setGradientStart(int value)
value
- Value to set property topublic int getHeight()
public void setHeight(int value)
value
- Value to set property topublic int getLanguageDirection()
public void setLanguageDirection(int value)
value
- Value to set property topublic int getParentModuleType()
public void setParentModuleType(int value)
value
- Value to set property topublic int getParentType()
public void setParentType(int value)
value
- Value to set property topublic int getPersistentClientInfoLength()
public void setPersistentClientInfoLength(int value)
value
- Value to set property topublic int getTabActionStyle()
public void setTabActionStyle(int value)
value
- Value to set property topublic int getTabAttachmentEdge()
public void setTabAttachmentEdge(int value)
value
- Value to set property topublic int getTabStyle()
public void setTabStyle(int value)
value
- Value to set property topublic int getTabWidthStyle()
public void setTabWidthStyle(int value)
value
- Value to set property topublic int getViewportHeight()
public void setViewportHeight(int value)
value
- Value to set property topublic int getViewportWidth()
public void setViewportWidth(int value)
value
- Value to set property topublic int getViewportXPosition()
public void setViewportXPosition(int value)
value
- Value to set property topublic int getViewportXPositionOnCanvas()
public void setViewportXPositionOnCanvas(int value)
value
- Value to set property topublic int getViewportYPosition()
public void setViewportYPosition(int value)
value
- Value to set property topublic int getViewportYPositionOnCanvas()
public void setViewportYPositionOnCanvas(int value)
value
- Value to set property topublic int getWidth()
public void setWidth(int value)
value
- Value to set property topublic boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property topublic boolean isDisplayViewport()
public void setDisplayViewport(boolean value)
value
- Value to set property topublic boolean isRaiseOnEnter()
public void setRaiseOnEnter(boolean value)
value
- Value to set property topublic boolean isShowHorizontalScrollbar()
public void setShowHorizontalScrollbar(boolean value)
value
- Value to set property topublic boolean isShowVerticalScrollbar()
public void setShowVerticalScrollbar(boolean value)
value
- Value to set property topublic boolean isSubclassObjectGroup()
public void setSubclassObjectGroup(boolean value)
value
- Value to set property topublic boolean isVisible()
public void setVisible(boolean value)
value
- Value to set property topublic JdapiIterator getGraphicses()
public JdapiObject getModule()
getModule
in interface JdapiObject
getModule
in class BaseFormsObject
public JdapiObject getOwner()
getOwner
in interface JdapiObject
getOwner
in class BaseFormsObject
public Menu getPopupMenuObject()
public void setPopupMenuObject(Menu value)
value
- Menu object to set property topublic JdapiObject getSource()
public JdapiIterator getTabPages()
public VisualAttribute getVisualAttributeObject()
public void setVisualAttributeObject(VisualAttribute value)
value
- VisualAttribute object to set property topublic JdapiIterator getVisualStates()
public Window getWindowObject()
public void setWindowObject(Window value)
value
- Window object to set property to