public class VisualAttribute 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 |
---|---|
|
VisualAttribute(FormModule parent,
java.lang.String name)
Constructor used to create VisualAttribute objects in the context of
a FormModule parent object.
|
|
VisualAttribute(FormModule parent,
java.lang.String name,
PropertyClass base)
Constructor used to create VisualAttribute objects in the context of a
FormModule parent object.
|
|
VisualAttribute(FormModule parent,
java.lang.String name,
VisualAttribute base)
Constructor used to create VisualAttribute objects in the context of a
FormModule parent object.
|
protected |
VisualAttribute(long pd2fvat)
Protected constructor, used internally to create VisualAttribute
objects.
|
|
VisualAttribute(MenuModule parent,
java.lang.String name)
Constructor used to create VisualAttribute objects in the context of
a MenuModule parent object.
|
|
VisualAttribute(MenuModule parent,
java.lang.String name,
PropertyClass base)
Constructor used to create VisualAttribute objects in the context of a
MenuModule parent object.
|
|
VisualAttribute(MenuModule parent,
java.lang.String name,
VisualAttribute base)
Constructor used to create VisualAttribute objects in the context of a
MenuModule parent object.
|
|
VisualAttribute(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name)
Constructor used to create VisualAttribute objects in the context of
an ObjectLibraryTab parent object.
|
|
VisualAttribute(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
PropertyClass base)
Constructor used to create VisualAttribute objects in the context of an
ObjectLibraryTab parent object.
|
|
VisualAttribute(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
VisualAttribute base)
Constructor used to create VisualAttribute objects in the context of an
ObjectLibraryTab parent object.
|
Modifier and Type | Method and Description |
---|---|
VisualAttribute |
clone(FormModule parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
VisualAttribute |
clone(MenuModule parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
VisualAttribute |
clone(ObjectLibraryTab parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
static VisualAttribute |
find(FormModule parent,
java.lang.String name)
Find an instance of VisualAttribute that is a child of a FormModule.
|
static VisualAttribute |
find(MenuModule parent,
java.lang.String name)
Find an instance of VisualAttribute that is a child of a MenuModule.
|
static VisualAttribute |
find(ObjectLibraryTab parent,
java.lang.String name)
Find an instance of VisualAttribute that is a child of a ObjectLibraryTab.
|
java.lang.String |
getBackColor()
Get text property BackColor (BACK_COLOR_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).
|
java.lang.String |
getFrameTitleBackColor()
Get text property FrameTitleBackColor (FRAME_TITLE_BACK_COLOR_PTID).
|
java.lang.String |
getFrameTitleFillPattern()
Get text property FrameTitleFillPattern (FRAME_TITLE_FILL_PATTERN_PTID).
|
java.lang.String |
getFrameTitleFontName()
Get text property FrameTitleFontName (FRAME_TITLE_FONT_NAME_PTID).
|
int |
getFrameTitleFontSize()
Get number property FrameTitleFontSize (FRAME_TITLE_FONT_SIZE_PTID).
|
int |
getFrameTitleFontSpacing()
Get number property FrameTitleFontSpacing (FRAME_TITLE_FONT_SPACING_PTID).
|
int |
getFrameTitleFontStyle()
Get number property FrameTitleFontStyle (FRAME_TITLE_FONT_STYLE_PTID).
|
int |
getFrameTitleFontWeight()
Get number property FrameTitleFontWeight (FRAME_TITLE_FONT_WEIGHT_PTID).
|
java.lang.String |
getFrameTitleForegroundColor()
Get text property FrameTitleForegroundColor (FRAME_TITLE_FOREGROUND_COLOR_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 |
getPromptBackColor()
Get text property PromptBackColor (PROMPT_BACK_COLOR_PTID).
|
java.lang.String |
getPromptFillPattern()
Get text property PromptFillPattern (PROMPT_FILL_PATTERN_PTID).
|
java.lang.String |
getPromptFontName()
Get text property PromptFontName (PROMPT_FONT_NAME_PTID).
|
int |
getPromptFontSize()
Get number property PromptFontSize (PROMPT_FONT_SIZE_PTID).
|
int |
getPromptFontSpacing()
Get number property PromptFontSpacing (PROMPT_FONT_SPACING_PTID).
|
int |
getPromptFontStyle()
Get number property PromptFontStyle (PROMPT_FONT_STYLE_PTID).
|
int |
getPromptFontWeight()
Get number property PromptFontWeight (PROMPT_FONT_WEIGHT_PTID).
|
java.lang.String |
getPromptForegroundColor()
Get text property PromptForegroundColor (PROMPT_FOREGROUND_COLOR_PTID).
|
JdapiObject |
getSource()
Get object property Source (SOURCE_PTID).
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
int |
getVisualAttributeType()
Get number property VisualAttributeType (VISUALATTRIBUTE_TYPE_PTID).
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
|
boolean |
isSubclassObjectGroup()
Get boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).
|
void |
setBackColor(java.lang.String value)
Sets text property BackColor (BACK_COLOR_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 |
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 |
setFrameTitleBackColor(java.lang.String value)
Sets text property FrameTitleBackColor (FRAME_TITLE_BACK_COLOR_PTID).
|
void |
setFrameTitleFillPattern(java.lang.String value)
Sets text property FrameTitleFillPattern (FRAME_TITLE_FILL_PATTERN_PTID).
|
void |
setFrameTitleFontName(java.lang.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 |
setFrameTitleForegroundColor(java.lang.String value)
Sets text property FrameTitleForegroundColor (FRAME_TITLE_FOREGROUND_COLOR_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 |
setPromptBackColor(java.lang.String value)
Sets text property PromptBackColor (PROMPT_BACK_COLOR_PTID).
|
void |
setPromptFillPattern(java.lang.String value)
Sets text property PromptFillPattern (PROMPT_FILL_PATTERN_PTID).
|
void |
setPromptFontName(java.lang.String value)
Sets text property PromptFontName (PROMPT_FONT_NAME_PTID).
|
void |
setPromptFontSize(int value)
Sets number property PromptFontSize (PROMPT_FONT_SIZE_PTID).
|
void |
setPromptFontSpacing(int value)
Sets number property PromptFontSpacing (PROMPT_FONT_SPACING_PTID).
|
void |
setPromptFontStyle(int value)
Sets number property PromptFontStyle (PROMPT_FONT_STYLE_PTID).
|
void |
setPromptFontWeight(int value)
Sets number property PromptFontWeight (PROMPT_FONT_WEIGHT_PTID).
|
void |
setPromptForegroundColor(java.lang.String value)
Sets text property PromptForegroundColor (PROMPT_FOREGROUND_COLOR_PTID).
|
void |
setSubclassObjectGroup(boolean value)
Sets boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).
|
void |
setVisualAttributeType(int value)
Sets number property VisualAttributeType (VISUALATTRIBUTE_TYPE_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 VisualAttribute(FormModule parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic VisualAttribute(FormModule parent, java.lang.String name, VisualAttribute base)
parent
- Parent objectname
- Name of the new objectbase
- VisualAttribute object to derive frompublic VisualAttribute(FormModule parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic VisualAttribute(MenuModule parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic VisualAttribute(MenuModule parent, java.lang.String name, VisualAttribute base)
parent
- Parent objectname
- Name of the new objectbase
- VisualAttribute object to derive frompublic VisualAttribute(MenuModule parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic VisualAttribute(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 VisualAttribute(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, VisualAttribute 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
- VisualAttribute object to derive frompublic VisualAttribute(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 VisualAttribute(long pd2fvat)
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);
pd2fvat
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public VisualAttribute clone(FormModule parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic VisualAttribute clone(MenuModule parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic VisualAttribute clone(ObjectLibraryTab parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static VisualAttribute find(FormModule parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static VisualAttribute find(MenuModule parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static VisualAttribute 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 getFrameTitleBackColor()
public void setFrameTitleBackColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getFrameTitleFillPattern()
public void setFrameTitleFillPattern(java.lang.String value)
value
- Value to set property topublic java.lang.String getFrameTitleFontName()
public void setFrameTitleFontName(java.lang.String value)
value
- Value to set property topublic java.lang.String getFrameTitleForegroundColor()
public void setFrameTitleForegroundColor(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 getPromptBackColor()
public void setPromptBackColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptFillPattern()
public void setPromptFillPattern(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptFontName()
public void setPromptFontName(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptForegroundColor()
public void setPromptForegroundColor(java.lang.String 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 getFrameTitleFontSize()
public void setFrameTitleFontSize(int value)
value
- Value to set property topublic int getFrameTitleFontSpacing()
public void setFrameTitleFontSpacing(int value)
value
- Value to set property topublic int getFrameTitleFontStyle()
public void setFrameTitleFontStyle(int value)
value
- Value to set property topublic int getFrameTitleFontWeight()
public void setFrameTitleFontWeight(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 getPromptFontSize()
public void setPromptFontSize(int value)
value
- Value to set property topublic int getPromptFontSpacing()
public void setPromptFontSpacing(int value)
value
- Value to set property topublic int getPromptFontStyle()
public void setPromptFontStyle(int value)
value
- Value to set property topublic int getPromptFontWeight()
public void setPromptFontWeight(int value)
value
- Value to set property topublic int getVisualAttributeType()
public void setVisualAttributeType(int value)
value
- Value to set property topublic boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property topublic boolean isSubclassObjectGroup()
public void setSubclassObjectGroup(boolean value)
value
- Value to set property topublic JdapiObject getModule()
getModule
in interface JdapiObject
getModule
in class BaseFormsObject
public JdapiObject getOwner()
getOwner
in interface JdapiObject
getOwner
in class BaseFormsObject
public JdapiObject getSource()