public class Editor 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 |
---|---|
|
Editor(FormModule parent,
java.lang.String name)
Constructor used to create Editor objects in the context of
a FormModule parent object.
|
|
Editor(FormModule parent,
java.lang.String name,
Editor base)
Constructor used to create Editor objects in the context of a
FormModule parent object.
|
|
Editor(FormModule parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Editor objects in the context of a
FormModule parent object.
|
protected |
Editor(long pd2fedt)
Protected constructor, used internally to create Editor
objects.
|
|
Editor(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name)
Constructor used to create Editor objects in the context of
an ObjectLibraryTab parent object.
|
|
Editor(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
Editor base)
Constructor used to create Editor objects in the context of an
ObjectLibraryTab parent object.
|
|
Editor(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
PropertyClass base)
Constructor used to create Editor objects in the context of an
ObjectLibraryTab parent object.
|
Modifier and Type | Method and Description |
---|---|
Editor |
clone(FormModule parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
Editor |
clone(ObjectLibraryTab parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
static Editor |
find(FormModule parent,
java.lang.String name)
Find an instance of Editor that is a child of a FormModule.
|
static Editor |
find(ObjectLibraryTab parent,
java.lang.String name)
Find an instance of Editor that is a child of a ObjectLibraryTab.
|
java.lang.String |
getBackColor()
Get text property BackColor (BACK_COLOR_PTID).
|
java.lang.String |
getBottomTitle()
Get text property BottomTitle (BOTTOM_TITLE_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 |
getHeight()
Get number property Height (HEIGHT_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).
|
JdapiObject |
getSource()
Get object property Source (SOURCE_PTID).
|
java.lang.String |
getTitle()
Get text property Title (TITLE_PTID).
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
java.lang.String |
getVisualAttributeName()
Get text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).
|
VisualAttribute |
getVisualAttributeObject()
Get object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).
|
int |
getWidth()
Get number property Width (WIDTH_PTID).
|
int |
getWrapStyle()
Get number property WrapStyle (WRAP_STYLE_PTID).
|
int |
getXPosition()
Get number property XPosition (X_POSITION_PTID).
|
int |
getYPosition()
Get number property YPosition (Y_POSITION_PTID).
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_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).
|
void |
setBackColor(java.lang.String value)
Sets text property BackColor (BACK_COLOR_PTID).
|
void |
setBottomTitle(java.lang.String value)
Sets text property BottomTitle (BOTTOM_TITLE_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 |
setHeight(int value)
Sets number property Height (HEIGHT_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 |
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 |
setTitle(java.lang.String value)
Sets text property Title (TITLE_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 |
setWrapStyle(int value)
Sets number property WrapStyle (WRAP_STYLE_PTID).
|
void |
setXPosition(int value)
Sets number property XPosition (X_POSITION_PTID).
|
void |
setYPosition(int value)
Sets number property YPosition (Y_POSITION_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 Editor(FormModule parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Editor(FormModule parent, java.lang.String name, Editor base)
parent
- Parent objectname
- Name of the new objectbase
- Editor object to derive frompublic Editor(FormModule parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Editor(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 Editor(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, Editor 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
- Editor object to derive frompublic Editor(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 Editor(long pd2fedt)
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);
pd2fedt
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public Editor clone(FormModule parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Editor clone(ObjectLibraryTab parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static Editor find(FormModule parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Editor 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 getBottomTitle()
public void setBottomTitle(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 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 getTitle()
public void setTitle(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 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 getHeight()
public void setHeight(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 getWidth()
public void setWidth(int value)
value
- Value to set property topublic int getWrapStyle()
public void setWrapStyle(int value)
value
- Value to set property topublic int getXPosition()
public void setXPosition(int value)
value
- Value to set property topublic int getYPosition()
public void setYPosition(int value)
value
- Value to set property topublic boolean isDirtyInfo()
public void setDirtyInfo(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 JdapiObject getModule()
getModule
in interface JdapiObject
getModule
in class BaseFormsObject
public JdapiObject getOwner()
getOwner
in interface JdapiObject
getOwner
in class BaseFormsObject
public JdapiObject getSource()
public VisualAttribute getVisualAttributeObject()
public void setVisualAttributeObject(VisualAttribute value)
value
- VisualAttribute object to set property to