public class MenuModule extends JdapiModule
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 |
MenuModule(long pd2fmmd)
Protected constructor, used internally to create MenuModule
objects.
|
|
MenuModule(java.lang.String name)
Constructor used to create MenuModule objects.
|
Modifier and Type | Method and Description |
---|---|
void |
addRole(int index,
java.lang.String role)
Adds a role to the list of roles for a menu module.
|
MenuModule |
clone(java.lang.String newName)
Creates a copy of the object as a child of 'parent'.
|
void |
compile()
Compiles the module to the filesystem.
|
static MenuModule |
find(java.lang.String name)
Find an instance of MenuModule.
|
JdapiIterator |
getAttachedLibraries()
Accessor for child AttachedLibrary objects (ATTACHMENT_LIBRARY_PTID).
|
java.lang.String |
getComment()
Get text property Comment (COMMENT_PTID).
|
java.lang.String |
getMainMenu()
Get text property MainMenu (MAIN_MENU_PTID).
|
java.lang.String |
getMenuDirectory()
Get text property MenuDirectory (MENU_DIRECTORY_PTID).
|
java.lang.String |
getMenuFilename()
Get text property MenuFilename (MENU_FILENAME_PTID).
|
JdapiIterator |
getMenus()
Accessor for child Menu objects (MENU_PTID).
|
java.lang.String |
getName()
Get text property Name (NAME_PTID).
|
JdapiIterator |
getObjectGroups()
Accessor for child ObjectGroup objects (OBJECT_GROUP_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).
|
JdapiIterator |
getProgramUnits()
Accessor for child ProgramUnit objects (PROGRAM_UNIT_PTID).
|
JdapiIterator |
getPropertyClasses()
Accessor for child PropertyClass objects (PROPERTY_CLASS_PTID).
|
java.lang.String |
getRole(int index)
Gets the name of a role from a menu module's list of roles.
|
int |
getRoleCount()
Get number property RoleCount (ROLE_COUNT_PTID).
|
java.lang.String |
getStartupCode()
Get text property StartupCode (STARTUP_CODE_PTID).
|
TranslationTable |
getTranslationTable()
Get a TranslationTable object representing the translations for this module.
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
JdapiIterator |
getVisualAttributes()
Accessor for child VisualAttribute objects (VISUAL_ATTRIBUTE_PTID).
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
|
boolean |
isShareLibrary()
Get boolean property ShareLibrary (SHARE_LIBRARY_PTID).
|
boolean |
isUseSecurity()
Get boolean property UseSecurity (USE_SECURITY_PTID).
|
static MenuModule |
open(java.io.File file)
Loads a MenuModule module from the filesystem or from the loaded
modules list.
|
static MenuModule |
open(java.io.File file,
java.lang.String formsPath)
Loads a MenuModule module from the filesystem or from the loaded
modules list.
|
static MenuModule |
open(java.lang.String fileName)
Loads a MenuModule module from the filesystem or from the loaded
modules list.
|
static MenuModule |
open(java.lang.String fileName,
java.lang.String formsPath)
Loads a MenuModule module from the filesystem or from the loaded
modules list.
|
void |
removeRole(int index)
Removes a role from the list of roles for a menu module.
|
void |
save(java.lang.String fileName)
Saves the module to the filesystem.
|
void |
setComment(java.lang.String value)
Sets text property Comment (COMMENT_PTID).
|
void |
setDirtyInfo(boolean value)
Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
|
void |
setMainMenu(java.lang.String value)
Sets text property MainMenu (MAIN_MENU_PTID).
|
void |
setMenuDirectory(java.lang.String value)
Sets text property MenuDirectory (MENU_DIRECTORY_PTID).
|
void |
setMenuFilename(java.lang.String value)
Sets text property MenuFilename (MENU_FILENAME_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 |
setShareLibrary(boolean value)
Sets boolean property ShareLibrary (SHARE_LIBRARY_PTID).
|
void |
setStartupCode(java.lang.String value)
Sets text property StartupCode (STARTUP_CODE_PTID).
|
void |
setUseSecurity(boolean value)
Sets boolean property UseSecurity (USE_SECURITY_PTID).
|
compile_all, destroy, getAbsolutePath, getModulesProductVersion, openModule, openModule, openModule, openModule, setAbsolutePath
changeOwner, clearObjectPointer, clone, createSubclassedChild, 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 MenuModule(java.lang.String name)
name
- Name of the new objectprotected MenuModule(long pd2fmmd)
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);
pd2fmmd
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public static MenuModule open(java.lang.String fileName)
A runtime exception is thrown if
a module the file has subclassed from cannot be found on the
Forms path. This behaviour can be suppressed with the
Jdapi.setFailSubclassLoad()
method.
fileName
- File name of MenuModule to loadpublic static MenuModule open(java.io.File file)
A runtime exception is thrown if
a module the file has subclassed from cannot be found on the
Forms path. This behaviour can be suppressed with the
Jdapi.setFailSubclassLoad()
method.
file
- File representing MenuModule to loadpublic static MenuModule open(java.lang.String fileName, java.lang.String formsPath)
A runtime exception is thrown if
a module the file has subclassed from cannot be found on the
Forms path. This behaviour can be suppressed with the
Jdapi.setFailSubclassLoad()
method.
fileName
- Filename of MenuModule to loadformsPath
- Path to use to look for modules that have been
subclassed from. 'null' means use the default
FORMS70_PATH.public static MenuModule open(java.io.File file, java.lang.String formsPath)
A runtime exception is thrown if
a module the file has subclassed from cannot be found on the
Forms path. This behaviour can be suppressed with the
Jdapi.setFailSubclassLoad()
method.
file
- File representing MenuModule to loadformsPath
- Path to use to look for modules that have been
subclassed from. 'null' means use the default
FORMS70_PATH.public void save(java.lang.String fileName)
save
in class JdapiModule
fileName
- Filename to save aspublic void compile()
compile
in class JdapiModule
public MenuModule clone(java.lang.String newName)
newName
- Name of object that's being createdpublic static MenuModule find(java.lang.String name)
name
- Name of object you wish to findpublic void addRole(int index, java.lang.String role)
index
- Index to add role atrole
- The name of the rolepublic void removeRole(int index)
index
- Index of role to removepublic java.lang.String getRole(int index)
index
- Index of role to getpublic TranslationTable getTranslationTable()
public java.lang.String getComment()
public void setComment(java.lang.String value)
value
- Value to set property topublic java.lang.String getMainMenu()
public void setMainMenu(java.lang.String value)
value
- Value to set property topublic java.lang.String getMenuDirectory()
public void setMenuDirectory(java.lang.String value)
value
- Value to set property topublic java.lang.String getMenuFilename()
public void setMenuFilename(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 getStartupCode()
public void setStartupCode(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 int getRoleCount()
public boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property topublic boolean isShareLibrary()
public void setShareLibrary(boolean value)
value
- Value to set property topublic boolean isUseSecurity()
public void setUseSecurity(boolean value)
value
- Value to set property topublic JdapiIterator getAttachedLibraries()
public JdapiIterator getMenus()
public JdapiIterator getObjectGroups()
public JdapiIterator getProgramUnits()
public JdapiIterator getPropertyClasses()
public JdapiIterator getVisualAttributes()