public class Trigger 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 |
---|---|
|
Trigger(Block parent,
java.lang.String name)
Constructor used to create Trigger objects in the context of
a Block parent object.
|
|
Trigger(Block parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Trigger objects in the context of a
Block parent object.
|
|
Trigger(Block parent,
java.lang.String name,
Trigger base)
Constructor used to create Trigger objects in the context of a
Block parent object.
|
|
Trigger(Event parent,
java.lang.String name)
Constructor used to create Trigger objects in the context of
a Event parent object.
|
|
Trigger(Event parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Trigger objects in the context of a
Event parent object.
|
|
Trigger(Event parent,
java.lang.String name,
Trigger base)
Constructor used to create Trigger objects in the context of a
Event parent object.
|
|
Trigger(FormModule parent,
java.lang.String name)
Constructor used to create Trigger objects in the context of
a FormModule parent object.
|
|
Trigger(FormModule parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Trigger objects in the context of a
FormModule parent object.
|
|
Trigger(FormModule parent,
java.lang.String name,
Trigger base)
Constructor used to create Trigger objects in the context of a
FormModule parent object.
|
|
Trigger(Item parent,
java.lang.String name)
Constructor used to create Trigger objects in the context of
a Item parent object.
|
|
Trigger(Item parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Trigger objects in the context of a
Item parent object.
|
|
Trigger(Item parent,
java.lang.String name,
Trigger base)
Constructor used to create Trigger objects in the context of a
Item parent object.
|
protected |
Trigger(long pd2ftrg)
Protected constructor, used internally to create Trigger
objects.
|
|
Trigger(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name)
Constructor used to create Trigger objects in the context of
an ObjectLibraryTab parent object.
|
|
Trigger(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
PropertyClass base)
Constructor used to create Trigger objects in the context of an
ObjectLibraryTab parent object.
|
|
Trigger(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
Trigger base)
Constructor used to create Trigger objects in the context of an
ObjectLibraryTab parent object.
|
|
Trigger(PropertyClass parent,
java.lang.String name)
Constructor used to create Trigger objects in the context of
a PropertyClass parent object.
|
|
Trigger(PropertyClass parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Trigger objects in the context of a
PropertyClass parent object.
|
|
Trigger(PropertyClass parent,
java.lang.String name,
Trigger base)
Constructor used to create Trigger objects in the context of a
PropertyClass parent object.
|
Modifier and Type | Method and Description |
---|---|
Trigger |
clone(Block parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
Trigger |
clone(Event parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
Trigger |
clone(FormModule parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
Trigger |
clone(Item parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
Trigger |
clone(ObjectLibraryTab parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
Trigger |
clone(PropertyClass parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
static Trigger |
find(Block parent,
java.lang.String name)
Find an instance of Trigger that is a child of a Block.
|
static Trigger |
find(Event parent,
java.lang.String name)
Find an instance of Trigger that is a child of a Event.
|
static Trigger |
find(FormModule parent,
java.lang.String name)
Find an instance of Trigger that is a child of a FormModule.
|
static Trigger |
find(Item parent,
java.lang.String name)
Find an instance of Trigger that is a child of a Item.
|
static Trigger |
find(ObjectLibraryTab parent,
java.lang.String name)
Find an instance of Trigger that is a child of a ObjectLibraryTab.
|
static Trigger |
find(PropertyClass parent,
java.lang.String name)
Find an instance of Trigger that is a child of a PropertyClass.
|
java.lang.String |
getComment()
Get text property Comment (COMMENT_PTID).
|
int |
getExecuteHierarchy()
Get number property ExecuteHierarchy (EXECUTE_HIERARCHY_PTID).
|
java.lang.String |
getKeyboardHelpText()
Get text property KeyboardHelpText (KEYBOARD_HELP_TEXT_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).
|
java.lang.String |
getParentSourceLevel1ObjectName()
Get text property ParentSourceLevel1ObjectName (PARENT_SOURCELEVEL1OBJECT_NAME_PTID).
|
int |
getParentSourceLevel1ObjectType()
Get number property ParentSourceLevel1ObjectType (PARENT_SOURCELEVEL1OBJECT_TYPE_PTID).
|
java.lang.String |
getParentSourceLevel2ObjectName()
Get text property ParentSourceLevel2ObjectName (PARENT_SOURCELEVEL2OBJECT_NAME_PTID).
|
int |
getParentSourceLevel2ObjectType()
Get number property ParentSourceLevel2ObjectType (PARENT_SOURCELEVEL2OBJECT_TYPE_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).
|
int |
getTriggerInternalType()
Get number property TriggerInternalType (TRIGGER_INTERNAL_TYPE_PTID).
|
int |
getTriggerStyle()
Get number property TriggerStyle (TRIGGER_STYLE_PTID).
|
java.lang.String |
getTriggerText()
Get text property TriggerText (TRIGGER_TEXT_PTID).
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
|
boolean |
isDisplayInKeyboardHelp()
Get boolean property DisplayInKeyboardHelp (DISPLAY_IN_KEYBOARD_HELP_PTID).
|
boolean |
isFireInQuery()
Get boolean property FireInQuery (FIRE_IN_QUERY_PTID).
|
boolean |
isHide()
Get boolean property Hide (HIDE_PTID).
|
boolean |
isSubclassObjectGroup()
Get boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).
|
boolean |
isSubclassSubObject()
Get boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_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 |
setDisplayInKeyboardHelp(boolean value)
Sets boolean property DisplayInKeyboardHelp (DISPLAY_IN_KEYBOARD_HELP_PTID).
|
void |
setExecuteHierarchy(int value)
Sets number property ExecuteHierarchy (EXECUTE_HIERARCHY_PTID).
|
void |
setFireInQuery(boolean value)
Sets boolean property FireInQuery (FIRE_IN_QUERY_PTID).
|
void |
setHide(boolean value)
Sets boolean property Hide (HIDE_PTID).
|
void |
setKeyboardHelpText(java.lang.String value)
Sets text property KeyboardHelpText (KEYBOARD_HELP_TEXT_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 |
setParentSourceLevel1ObjectName(java.lang.String value)
Sets text property ParentSourceLevel1ObjectName (PARENT_SOURCELEVEL1OBJECT_NAME_PTID).
|
void |
setParentSourceLevel1ObjectType(int value)
Sets number property ParentSourceLevel1ObjectType (PARENT_SOURCELEVEL1OBJECT_TYPE_PTID).
|
void |
setParentSourceLevel2ObjectName(java.lang.String value)
Sets text property ParentSourceLevel2ObjectName (PARENT_SOURCELEVEL2OBJECT_NAME_PTID).
|
void |
setParentSourceLevel2ObjectType(int value)
Sets number property ParentSourceLevel2ObjectType (PARENT_SOURCELEVEL2OBJECT_TYPE_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 |
setSubclassObjectGroup(boolean value)
Sets boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).
|
void |
setSubclassSubObject(boolean value)
Sets boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).
|
void |
setTriggerInternalType(int value)
Sets number property TriggerInternalType (TRIGGER_INTERNAL_TYPE_PTID).
|
void |
setTriggerStyle(int value)
Sets number property TriggerStyle (TRIGGER_STYLE_PTID).
|
void |
setTriggerText(java.lang.String value)
Sets text property TriggerText (TRIGGER_TEXT_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 Trigger(Item parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Trigger(Item parent, java.lang.String name, Trigger base)
parent
- Parent objectname
- Name of the new objectbase
- Trigger object to derive frompublic Trigger(Item parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Trigger(Block parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Trigger(Block parent, java.lang.String name, Trigger base)
parent
- Parent objectname
- Name of the new objectbase
- Trigger object to derive frompublic Trigger(Block parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Trigger(Event parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Trigger(Event parent, java.lang.String name, Trigger base)
parent
- Parent objectname
- Name of the new objectbase
- Trigger object to derive frompublic Trigger(Event parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Trigger(PropertyClass parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Trigger(PropertyClass parent, java.lang.String name, Trigger base)
parent
- Parent objectname
- Name of the new objectbase
- Trigger object to derive frompublic Trigger(PropertyClass parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Trigger(FormModule parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Trigger(FormModule parent, java.lang.String name, Trigger base)
parent
- Parent objectname
- Name of the new objectbase
- Trigger object to derive frompublic Trigger(FormModule parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Trigger(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 Trigger(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, Trigger 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
- Trigger object to derive frompublic Trigger(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 Trigger(long pd2ftrg)
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);
pd2ftrg
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public Trigger clone(Item parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Trigger clone(Block parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Trigger clone(Event parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Trigger clone(PropertyClass parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Trigger clone(FormModule parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Trigger clone(ObjectLibraryTab parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static Trigger find(Item parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Trigger find(Block parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Trigger find(Event parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Trigger find(PropertyClass parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Trigger find(FormModule parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Trigger 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 getComment()
public void setComment(java.lang.String value)
value
- Value to set property topublic java.lang.String getKeyboardHelpText()
public void setKeyboardHelpText(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 getParentSourceLevel1ObjectName()
public void setParentSourceLevel1ObjectName(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentSourceLevel2ObjectName()
public void setParentSourceLevel2ObjectName(java.lang.String value)
value
- Value to set property topublic java.lang.String getTriggerText()
public void setTriggerText(java.lang.String value)
value
- Value to set property topublic int getExecuteHierarchy()
public void setExecuteHierarchy(int value)
value
- Value to set property topublic int getParentModuleType()
public void setParentModuleType(int value)
value
- Value to set property topublic int getParentSourceLevel1ObjectType()
public void setParentSourceLevel1ObjectType(int value)
value
- Value to set property topublic int getParentSourceLevel2ObjectType()
public void setParentSourceLevel2ObjectType(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 getTriggerInternalType()
public void setTriggerInternalType(int value)
value
- Value to set property topublic int getTriggerStyle()
public void setTriggerStyle(int value)
value
- Value to set property topublic boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property topublic boolean isDisplayInKeyboardHelp()
public void setDisplayInKeyboardHelp(boolean value)
value
- Value to set property topublic boolean isFireInQuery()
public void setFireInQuery(boolean value)
value
- Value to set property topublic boolean isHide()
public void setHide(boolean value)
value
- Value to set property topublic boolean isSubclassObjectGroup()
public void setSubclassObjectGroup(boolean value)
value
- Value to set property topublic boolean isSubclassSubObject()
public void setSubclassSubObject(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()