public class AttachedLibrary 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 |
---|---|
|
AttachedLibrary(FormModule parent,
java.lang.String name)
Constructor.
|
protected |
AttachedLibrary(long pd2falb)
Protected constructor, used internally to create AttachedLibrary
objects.
|
|
AttachedLibrary(MenuModule parent,
java.lang.String name)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
AttachedLibrary |
clone(FormModule parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
AttachedLibrary |
clone(MenuModule parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
void |
detach()
Detaches the library from the parent object and destroys it.
|
static AttachedLibrary |
find(FormModule parent,
java.lang.String name)
Find an instance of AttachedLibrary that is a child of a FormModule.
|
static AttachedLibrary |
find(MenuModule parent,
java.lang.String name)
Find an instance of AttachedLibrary that is a child of a MenuModule.
|
java.lang.String |
getComment()
Get text property Comment (COMMENT_PTID).
|
java.lang.String |
getLibraryLocation()
Get text property LibraryLocation (LIBRARY_LOCATION_PTID).
|
int |
getLibrarySource()
Get number property LibrarySource (LIBRARY_SOURCE_PTID).
|
java.lang.String |
getName()
Get text property Name (NAME_PTID).
|
int |
getPersistentClientInfoLength()
Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
void |
setComment(java.lang.String value)
Sets text property Comment (COMMENT_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
protected AttachedLibrary(long pd2falb)
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);
pd2falb
- C pointer to Forms objectpublic AttachedLibrary(FormModule parent, java.lang.String name)
parent
- Parent objectname
- Name of library to attachpublic AttachedLibrary(MenuModule parent, java.lang.String name)
parent
- Parent objectname
- Name of library to attachpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public AttachedLibrary clone(FormModule parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic AttachedLibrary clone(MenuModule parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static AttachedLibrary find(FormModule parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static AttachedLibrary find(MenuModule parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic void detach()
public java.lang.String getComment()
public void setComment(java.lang.String value)
value
- Value to set property topublic java.lang.String getLibraryLocation()
public java.lang.String getName()
getName
in interface JdapiObject
getName
in class BaseFormsObject
public int getLibrarySource()
public int getPersistentClientInfoLength()
public void setPersistentClientInfoLength(int value)
value
- Value to set property to