public class Menu 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 |
---|---|
|
Menu(FormModule parent,
java.lang.String name)
Constructor used to create Menu objects in the context of
a FormModule parent object.
|
|
Menu(FormModule parent,
java.lang.String name,
Menu base)
Constructor used to create Menu objects in the context of a
FormModule parent object.
|
|
Menu(FormModule parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Menu objects in the context of a
FormModule parent object.
|
protected |
Menu(long pd2fmnu)
Protected constructor, used internally to create Menu
objects.
|
|
Menu(MenuModule parent,
java.lang.String name)
Constructor used to create Menu objects in the context of
a MenuModule parent object.
|
|
Menu(MenuModule parent,
java.lang.String name,
Menu base)
Constructor used to create Menu objects in the context of a
MenuModule parent object.
|
|
Menu(MenuModule parent,
java.lang.String name,
PropertyClass base)
Constructor used to create Menu objects in the context of a
MenuModule parent object.
|
|
Menu(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name)
Constructor used to create Menu objects in the context of
an ObjectLibraryTab parent object.
|
|
Menu(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
Menu base)
Constructor used to create Menu objects in the context of an
ObjectLibraryTab parent object.
|
|
Menu(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
PropertyClass base)
Constructor used to create Menu objects in the context of an
ObjectLibraryTab parent object.
|
Modifier and Type | Method and Description |
---|---|
Menu |
clone(FormModule parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
Menu |
clone(MenuModule parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
Menu |
clone(ObjectLibraryTab parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
static Menu |
find(FormModule parent,
java.lang.String name)
Find an instance of Menu that is a child of a FormModule.
|
static Menu |
find(MenuModule parent,
java.lang.String name)
Find an instance of Menu that is a child of a MenuModule.
|
static Menu |
find(ObjectLibraryTab parent,
java.lang.String name)
Find an instance of Menu that is a child of a ObjectLibraryTab.
|
java.lang.String |
getBottomTitle()
Get text property BottomTitle (BOTTOM_TITLE_PTID).
|
java.lang.String |
getComment()
Get text property Comment (COMMENT_PTID).
|
JdapiIterator |
getMenuItems()
Accessor for child MenuItem objects (MENU_ITEM_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 |
getSubTitle()
Get text property SubTitle (SUB_TITLE_PTID).
|
java.lang.String |
getTitle()
Get text property Title (TITLE_PTID).
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
|
boolean |
isSubclassObjectGroup()
Get boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).
|
boolean |
isTearOffMenu()
Get boolean property TearOffMenu (TEAR_OFF_MENU_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 |
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 |
setSubclassObjectGroup(boolean value)
Sets boolean property SubclassObjectGroup (SUBCLASS_OBJECTGROUP_PTID).
|
void |
setSubTitle(java.lang.String value)
Sets text property SubTitle (SUB_TITLE_PTID).
|
void |
setTearOffMenu(boolean value)
Sets boolean property TearOffMenu (TEAR_OFF_MENU_PTID).
|
void |
setTitle(java.lang.String value)
Sets text property Title (TITLE_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 Menu(FormModule parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Menu(FormModule parent, java.lang.String name, Menu base)
parent
- Parent objectname
- Name of the new objectbase
- Menu object to derive frompublic Menu(FormModule parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Menu(MenuModule parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic Menu(MenuModule parent, java.lang.String name, Menu base)
parent
- Parent objectname
- Name of the new objectbase
- Menu object to derive frompublic Menu(MenuModule parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic Menu(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 Menu(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, Menu 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
- Menu object to derive frompublic Menu(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 Menu(long pd2fmnu)
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);
pd2fmnu
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public Menu clone(FormModule parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Menu clone(MenuModule parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic Menu clone(ObjectLibraryTab parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static Menu find(FormModule parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Menu find(MenuModule parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static Menu 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 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 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 getSubTitle()
public void setSubTitle(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 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 boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property topublic boolean isSubclassObjectGroup()
public void setSubclassObjectGroup(boolean value)
value
- Value to set property topublic boolean isTearOffMenu()
public void setTearOffMenu(boolean value)
value
- Value to set property topublic JdapiIterator getMenuItems()
public JdapiObject getModule()
getModule
in interface JdapiObject
getModule
in class BaseFormsObject
public JdapiObject getOwner()
getOwner
in interface JdapiObject
getOwner
in class BaseFormsObject
public JdapiObject getSource()