public class TextSegment 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 |
---|---|
|
TextSegment(CompoundText parent,
java.lang.String name)
Constructor used to create TextSegment objects in the context of
a CompoundText parent object.
|
|
TextSegment(CompoundText parent,
java.lang.String name,
PropertyClass base)
Constructor used to create TextSegment objects in the context of a
CompoundText parent object.
|
|
TextSegment(CompoundText parent,
java.lang.String name,
TextSegment base)
Constructor used to create TextSegment objects in the context of a
CompoundText parent object.
|
protected |
TextSegment(long pd2ftxs)
Protected constructor, used internally to create TextSegment
objects.
|
Modifier and Type | Method and Description |
---|---|
TextSegment |
clone(CompoundText parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
static TextSegment |
find(CompoundText parent,
java.lang.String name)
Find an instance of TextSegment that is a child of a CompoundText.
|
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 |
getName()
Get text property Name (NAME_PTID).
|
java.lang.String |
getText()
Get text property Text (TEXT_PTID).
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
|
boolean |
isSubclassSubObject()
Get boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).
|
void |
setDirtyInfo(boolean value)
Sets boolean property DirtyInfo (DIRTY_INFO_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 |
setName(java.lang.String value)
Sets text property Name (NAME_PTID).
|
void |
setSubclassSubObject(boolean value)
Sets boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).
|
void |
setText(java.lang.String value)
Sets text property Text (TEXT_PTID).
|
changeOwner, clearObjectPointer, clone, createSubclassedChild, destroy, equals, getBooleanProperty, getChildObjectProperty, getClassName, getClientInfo, getIntegerProperty, getIntegerPropertyString, getJdapiMetaObject, getMetaProperties, getModule, getObjectPointer, getObjectProperty, getObjProp, getOwnedObjects, getOwner, 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 TextSegment(CompoundText parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic TextSegment(CompoundText parent, java.lang.String name, TextSegment base)
parent
- Parent objectname
- Name of the new objectbase
- TextSegment object to derive frompublic TextSegment(CompoundText parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive fromprotected TextSegment(long pd2ftxs)
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);
pd2ftxs
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public TextSegment clone(CompoundText parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static TextSegment find(CompoundText parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic 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 getText()
public void setText(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 boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property topublic boolean isSubclassSubObject()
public void setSubclassSubObject(boolean value)
value
- Value to set property to