public class ObjectLibraryTab 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 |
---|---|
protected |
ObjectLibraryTab(long pd2folt)
Protected constructor, used internally to create ObjectLibraryTab
objects.
|
|
ObjectLibraryTab(ObjectLibrary parent,
java.lang.String name)
Constructor used to create ObjectLibraryTab objects in the context of
a ObjectLibrary parent object.
|
|
ObjectLibraryTab(ObjectLibrary parent,
java.lang.String name,
ObjectLibraryTab base)
Constructor used to create ObjectLibraryTab objects in the context of a
ObjectLibrary parent object.
|
|
ObjectLibraryTab(ObjectLibrary parent,
java.lang.String name,
PropertyClass base)
Constructor used to create ObjectLibraryTab objects in the context of a
ObjectLibrary parent object.
|
Modifier and Type | Method and Description |
---|---|
JdapiObject |
addObject(JdapiObject obj,
boolean replace)
Add an object to the ObjectLibraryTab.
|
ObjectLibraryTab |
clone(ObjectLibrary parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
static ObjectLibraryTab |
find(ObjectLibrary parent,
java.lang.String name)
Find an instance of ObjectLibraryTab that is a child of a ObjectLibrary.
|
JdapiObject |
findObjectByPosition(int pos)
Gets an object from the ObjectLibraryTab based on it's index.
|
java.lang.String |
getComment()
Get text property Comment (COMMENT_PTID).
|
java.lang.String |
getLabel()
Get text property Label (LABEL_PTID).
|
java.lang.String |
getName()
Get text property Name (NAME_PTID).
|
int |
getObjectCount()
Get number property ObjectCount (OBJECT_COUNT_PTID).
|
int |
getPersistentClientInfoLength()
Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
|
JdapiIterator |
getTabObjects()
Gets an iterator over all the objects in the tab
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
|
void |
removeObject(JdapiObject obj)
Removes an object from the ObjectLibraryTab.
|
void |
setComment(java.lang.String value)
Sets text property Comment (COMMENT_PTID).
|
void |
setDirtyInfo(boolean value)
Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
|
void |
setLabel(java.lang.String value)
Sets text property Label (LABEL_PTID).
|
void |
setName(java.lang.String value)
Sets text property Name (NAME_PTID).
|
void |
setPersistentClientInfoLength(int value)
Sets number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_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 ObjectLibraryTab(ObjectLibrary parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic ObjectLibraryTab(ObjectLibrary parent, java.lang.String name, ObjectLibraryTab base)
parent
- Parent objectname
- Name of the new objectbase
- ObjectLibraryTab object to derive frompublic ObjectLibraryTab(ObjectLibrary parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive fromprotected ObjectLibraryTab(long pd2folt)
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);
pd2folt
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public ObjectLibraryTab clone(ObjectLibrary parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static ObjectLibraryTab find(ObjectLibrary parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic JdapiObject addObject(JdapiObject obj, boolean replace)
Note: Although you can add any Forms object (JdapiObject) to the ObjectLibrary using this method, Forms does not support all objects in a library, e.g. you can't put a Form in an object library (at time of writing). Trying to do so will have unexpected results, i.e. don't :)
obj
- Forms object to add to libraryreplace
- Replace existing object (?)public void removeObject(JdapiObject obj)
obj
- Object to removepublic JdapiIterator getTabObjects()
public JdapiObject findObjectByPosition(int pos)
getObjectCount()
method.pos
- Position to get object at, this is 1-basedpublic java.lang.String getComment()
public void setComment(java.lang.String value)
value
- Value to set property topublic java.lang.String getLabel()
public void setLabel(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 int getObjectCount()
public int getPersistentClientInfoLength()
public void setPersistentClientInfoLength(int value)
value
- Value to set property topublic boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property to