public class FormModule 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 |
FormModule(long pd2ffmd)
Protected constructor, used internally to create FormModule
objects.
|
|
FormModule(java.lang.String name)
Constructor used to create FormModule objects.
|
Modifier and Type | Method and Description |
---|---|
FormModule |
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 FormModule |
find(java.lang.String name)
Find an instance of FormModule.
|
JdapiIterator |
getAlerts()
Accessor for child Alert objects (ALERT_PTID).
|
JdapiIterator |
getAttachedLibraries()
Accessor for child AttachedLibrary objects (ATTACHMENT_LIBRARY_PTID).
|
JdapiIterator |
getBlocks()
Accessor for child Block objects (BLOCK_PTID).
|
JdapiIterator |
getCanvases()
Accessor for child Canvas objects (CANVAS_PTID).
|
java.lang.String |
getComment()
Get text property Comment (COMMENT_PTID).
|
java.lang.String |
getConsoleWindow()
Get text property ConsoleWindow (CONSOLE_WINDOW_PTID).
|
int |
getCursorMode()
Get number property CursorMode (CURSOR_MODE_PTID).
|
JdapiIterator |
getEditors()
Accessor for child Editor objects (EDITOR_PTID).
|
JdapiIterator |
getEvents()
Accessor for child Event objects (EVENT_PTID).
|
java.lang.String |
getFirstNavigationBlockName()
Get text property FirstNavigationBlockName (FIRST_NAVIGATION_BLOCK_NAME_PTID).
|
Block |
getFirstNavigationBlockObject()
Get object property FirstNavigationBlockObject (FIRST_NAVIGATION_BLOCK_OBJECT_PTID).
|
java.lang.String |
getHelpBookTitle()
Get text property HelpBookTitle (HELP_BOOK_TITLE_PTID).
|
java.lang.String |
getHorizontalToolbarCanvas()
Get text property HorizontalToolbarCanvas (HORIZONTAL_TOOLBAR_CANVAS_PTID).
|
java.lang.String |
getInitializeMenu()
Get text property InitializeMenu (INITIALIZE_MENU_PTID).
|
int |
getInteractionMode()
Get number property InteractionMode (INTERACTION_MODE_PTID).
|
int |
getIsolationMode()
Get number property IsolationMode (ISOLATION_MODE_PTID).
|
int |
getLanguageDirection()
Get number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
|
JdapiIterator |
getLOVs()
Accessor for child LOV objects (LOV_PTID).
|
int |
getMaximumQueryTime()
Get number property MaximumQueryTime (MAXIMUM_QUERY_TIME_PTID).
|
int |
getMaximumRecordsFetched()
Get number property MaximumRecordsFetched (MAXIMUM_RECORDS_FETCHED_PTID).
|
java.lang.String |
getMenuModule()
Get text property MenuModule (MENU_MODULE_PTID).
|
java.lang.String |
getMenuRole()
Get text property MenuRole (MENU_ROLE_PTID).
|
JdapiIterator |
getMenus()
Accessor for child Menu objects (MENU_PTID).
|
JdapiIterator |
getModuleParameters()
Accessor for child ModuleParameter objects (FORM_PARAMETER_PTID).
|
int |
getMouseNavigationLimit()
Get number property MouseNavigationLimit (MOUSE_NAVIGATION_LIMIT_PTID).
|
java.lang.String |
getName()
Get text property Name (NAME_PTID).
|
int |
getNewdeferReqEnf()
Get number property NewdeferReqEnf (NEWDEFER_REQ_ENF_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).
|
JdapiIterator |
getRecordGroups()
Accessor for child RecordGroup objects (RECORD_GROUP_PTID).
|
java.lang.String |
getRecordVisualAttributeGroupName()
Get text property RecordVisualAttributeGroupName (RECORD_VISUALATTRIBUTE_GROUP_NAME_PTID).
|
VisualAttribute |
getRecordVisualAttributeGroupObject()
Get object property RecordVisualAttributeGroupObject (RECORD_VISUALATTRIBUTE_GROUP_OBJECT_PTID).
|
JdapiIterator |
getReports()
Accessor for child Report objects (REPORT_PTID).
|
int |
getRuntimeComp()
Get number property RuntimeComp (RUNTIME_COMP_PTID).
|
java.lang.String |
getTitle()
Get text property Title (TITLE_PTID).
|
TranslationTable |
getTranslationTable()
Get a TranslationTable object representing the translations for this module.
|
JdapiIterator |
getTriggers()
Accessor for child Trigger objects (TRIGGER_PTID).
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
int |
getValidationUnit()
Get number property ValidationUnit (VALIDATION_UNIT_PTID).
|
java.lang.String |
getVerticalToolbarCanvas()
Get text property VerticalToolbarCanvas (VERTICAL_TOOLBAR_CANVAS_PTID).
|
JdapiIterator |
getVisualAttributes()
Accessor for child VisualAttribute objects (VISUAL_ATTRIBUTE_PTID).
|
JdapiIterator |
getWindows()
Accessor for child Window objects (WINDOW_PTID).
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
|
boolean |
isSavepointMode()
Get boolean property SavepointMode (SAVEPOINT_MODE_PTID).
|
boolean |
isUse3dControls()
Get boolean property Use3dControls (USE_3D_CONTROLS_PTID).
|
static FormModule |
open(java.io.File file)
Loads a FormModule module from the filesystem or from the loaded
modules list.
|
static FormModule |
open(java.io.File file,
java.lang.String formsPath)
Loads a FormModule module from the filesystem or from the loaded
modules list.
|
static FormModule |
open(java.lang.String fileName)
Loads a FormModule module from the filesystem or from the loaded
modules list.
|
static FormModule |
open(java.lang.String fileName,
java.lang.String formsPath)
Loads a FormModule module from the filesystem or from the loaded
modules list.
|
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 |
setConsoleWindow(java.lang.String value)
Sets text property ConsoleWindow (CONSOLE_WINDOW_PTID).
|
void |
setDirtyInfo(boolean value)
Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
|
void |
setFirstNavigationBlockName(java.lang.String value)
Sets text property FirstNavigationBlockName (FIRST_NAVIGATION_BLOCK_NAME_PTID).
|
void |
setFirstNavigationBlockObject(Block value)
Set object property FirstNavigationBlockObject (FIRST_NAVIGATION_BLOCK_OBJECT_PTID).
|
void |
setHelpBookTitle(java.lang.String value)
Sets text property HelpBookTitle (HELP_BOOK_TITLE_PTID).
|
void |
setHorizontalToolbarCanvas(java.lang.String value)
Sets text property HorizontalToolbarCanvas (HORIZONTAL_TOOLBAR_CANVAS_PTID).
|
void |
setInitializeMenu(java.lang.String value)
Sets text property InitializeMenu (INITIALIZE_MENU_PTID).
|
void |
setInteractionMode(int value)
Sets number property InteractionMode (INTERACTION_MODE_PTID).
|
void |
setIsolationMode(int value)
Sets number property IsolationMode (ISOLATION_MODE_PTID).
|
void |
setLanguageDirection(int value)
Sets number property LanguageDirection (LANGUAGE_DIRECTION_PTID).
|
void |
setMaximumQueryTime(int value)
Sets number property MaximumQueryTime (MAXIMUM_QUERY_TIME_PTID).
|
void |
setMaximumRecordsFetched(int value)
Sets number property MaximumRecordsFetched (MAXIMUM_RECORDS_FETCHED_PTID).
|
void |
setMenuModule(java.lang.String value)
Sets text property MenuModule (MENU_MODULE_PTID).
|
void |
setMenuRole(java.lang.String value)
Sets text property MenuRole (MENU_ROLE_PTID).
|
void |
setMouseNavigationLimit(int value)
Sets number property MouseNavigationLimit (MOUSE_NAVIGATION_LIMIT_PTID).
|
void |
setName(java.lang.String value)
Sets text property Name (NAME_PTID).
|
void |
setNewdeferReqEnf(int value)
Sets number property NewdeferReqEnf (NEWDEFER_REQ_ENF_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 |
setRecordVisualAttributeGroupName(java.lang.String value)
Sets text property RecordVisualAttributeGroupName (RECORD_VISUALATTRIBUTE_GROUP_NAME_PTID).
|
void |
setRecordVisualAttributeGroupObject(VisualAttribute value)
Set object property RecordVisualAttributeGroupObject (RECORD_VISUALATTRIBUTE_GROUP_OBJECT_PTID).
|
void |
setRuntimeComp(int value)
Sets number property RuntimeComp (RUNTIME_COMP_PTID).
|
void |
setTitle(java.lang.String value)
Sets text property Title (TITLE_PTID).
|
void |
setUse3dControls(boolean value)
Sets boolean property Use3dControls (USE_3D_CONTROLS_PTID).
|
void |
setValidationUnit(int value)
Sets number property ValidationUnit (VALIDATION_UNIT_PTID).
|
void |
setVerticalToolbarCanvas(java.lang.String value)
Sets text property VerticalToolbarCanvas (VERTICAL_TOOLBAR_CANVAS_PTID).
|
void |
wrapTranslatedText(Graphics pd2fgra,
java.lang.String language)
#(4292441) Jdapi for wrapping of boilerplate text needed.
|
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 FormModule(java.lang.String name)
name
- Name of the new objectprotected FormModule(long pd2ffmd)
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);
pd2ffmd
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public static FormModule 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 FormModule to loadpublic static FormModule 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 FormModule to loadpublic static FormModule 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 FormModule to loadformsPath
- Path to use to look for modules that have been
subclassed from. 'null' means use the default
FORMS70_PATH.public static FormModule 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 FormModule 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 FormModule clone(java.lang.String newName)
newName
- Name of object that's being createdpublic static FormModule find(java.lang.String name)
name
- Name of object you wish to findpublic TranslationTable getTranslationTable()
public void wrapTranslatedText(Graphics pd2fgra, java.lang.String language)
public java.lang.String getComment()
public void setComment(java.lang.String value)
value
- Value to set property topublic java.lang.String getConsoleWindow()
public void setConsoleWindow(java.lang.String value)
value
- Value to set property topublic java.lang.String getFirstNavigationBlockName()
public void setFirstNavigationBlockName(java.lang.String value)
value
- Value to set property topublic java.lang.String getHelpBookTitle()
public void setHelpBookTitle(java.lang.String value)
value
- Value to set property topublic java.lang.String getHorizontalToolbarCanvas()
public void setHorizontalToolbarCanvas(java.lang.String value)
value
- Value to set property topublic java.lang.String getInitializeMenu()
public void setInitializeMenu(java.lang.String value)
value
- Value to set property topublic java.lang.String getMenuModule()
public void setMenuModule(java.lang.String value)
value
- Value to set property topublic java.lang.String getMenuRole()
public void setMenuRole(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 getRecordVisualAttributeGroupName()
public void setRecordVisualAttributeGroupName(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 java.lang.String getVerticalToolbarCanvas()
public void setVerticalToolbarCanvas(java.lang.String value)
value
- Value to set property topublic int getCursorMode()
public int getInteractionMode()
public void setInteractionMode(int value)
value
- Value to set property topublic int getIsolationMode()
public void setIsolationMode(int value)
value
- Value to set property topublic int getLanguageDirection()
public void setLanguageDirection(int value)
value
- Value to set property topublic int getMaximumQueryTime()
public void setMaximumQueryTime(int value)
value
- Value to set property topublic int getMaximumRecordsFetched()
public void setMaximumRecordsFetched(int value)
value
- Value to set property topublic int getMouseNavigationLimit()
public void setMouseNavigationLimit(int value)
value
- Value to set property topublic int getNewdeferReqEnf()
public void setNewdeferReqEnf(int 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 getRuntimeComp()
public void setRuntimeComp(int value)
value
- Value to set property topublic int getValidationUnit()
public void setValidationUnit(int value)
value
- Value to set property topublic boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property topublic boolean isSavepointMode()
public boolean isUse3dControls()
public void setUse3dControls(boolean value)
value
- Value to set property topublic JdapiIterator getAlerts()
public JdapiIterator getAttachedLibraries()
public JdapiIterator getBlocks()
public JdapiIterator getCanvases()
public JdapiIterator getEditors()
public JdapiIterator getEvents()
public JdapiIterator getModuleParameters()
public Block getFirstNavigationBlockObject()
public void setFirstNavigationBlockObject(Block value)
value
- Block object to set property topublic JdapiIterator getLOVs()
public JdapiIterator getMenus()
public JdapiIterator getObjectGroups()
public JdapiIterator getProgramUnits()
public JdapiIterator getPropertyClasses()
public JdapiIterator getRecordGroups()
public VisualAttribute getRecordVisualAttributeGroupObject()
public void setRecordVisualAttributeGroupObject(VisualAttribute value)
value
- VisualAttribute object to set property topublic JdapiIterator getReports()
public JdapiIterator getTriggers()
public JdapiIterator getVisualAttributes()
public JdapiIterator getWindows()