|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.forms.jdapi.BaseFormsObject | +--oracle.forms.jdapi.JdapiModule | +--oracle.forms.jdapi.PlsqlModule
Object to represent a Forms PlsqlModule object. This is an encapsulation of the Forms C API d2flib.
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
Fields inherited from class oracle.forms.jdapi.JdapiModule |
m_clientInfo, m_pd2fob |
Fields inherited from interface oracle.forms.jdapi.JdapiObject |
PROPERTY_DEFAULT_VALUE, PROPERTY_INHERITED_VALUE, PROPERTY_OVERRIDDEN_DEFAULT_VALUE, PROPERTY_OVERRIDDEN_INHERITED_VALUE, PROPERTY_STATE_UNKNOWN |
Constructor Summary | |
protected |
PlsqlModule(long pd2flib)
Protected constructor, used internally to create PlsqlModule objects. |
Method Summary | |
PlsqlModule |
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 PlsqlModule |
find(java.lang.String name)
Find an instance of PlsqlModule. |
JdapiIterator |
getAttachedLibraries()
Accessor for child AttachedLibrary objects (ATTACHMENT_LIBRARY_PTID). |
java.lang.String |
getLibraryLocation()
Get text property LibraryLocation (LIBRARY_LOCATION_PTID). |
int |
getLibrarySource()
Get number property LibrarySource (LIBRARY_SOURCE_PTID). |
JdapiIterator |
getProgramUnits()
Accessor for child ProgramUnit objects (LIBRARY_PROGRAM_UNIT_PTID). |
int |
getTypeId()
Gets the HtmlForms object type ID. |
static PlsqlModule |
open(java.io.File file)
Loads a PlsqlModule module from the filesystem or from the loaded modules list. |
static PlsqlModule |
open(java.io.File file,
java.lang.String formsPath)
Loads a PlsqlModule module from the filesystem or from the loaded modules list. |
static PlsqlModule |
open(java.lang.String fileName)
Loads a PlsqlModule module from the filesystem or from the loaded modules list. |
static PlsqlModule |
open(java.lang.String fileName,
java.lang.String formsPath)
Loads a PlsqlModule module from the filesystem or from the loaded modules list. |
void |
save(java.lang.String fileName)
Saves the module to the filesystem. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
protected PlsqlModule(long pd2flib)
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);
pd2fctx
- C pointer to Forms contextpd2flib
- C pointer to Forms objectMethod Detail |
public int getTypeId()
getTypeId
in class oracle.forms.jdapi.BaseFormsObject
public static PlsqlModule 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 PlsqlModule to loadpublic static PlsqlModule 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.
fileName
- File representing PlsqlModule to loadpublic static PlsqlModule 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 PlsqlModule to loadformsPath
- Path to use to look for modules that have been
subclassed from. 'null' means use the default
FORMS70_PATH.public static PlsqlModule 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 PlsqlModule 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)
Note that this method is currently unsupported for PlsqlModule types, and if called, a JdapiUnsupportedOperationException will be thrown.
save
in class JdapiModule
fileName
- Filename to save aspublic void compile()
Note that this method is currently unsupported for PlsqlModule and ObjectLibrary types, and if called, a JdapiUnsupportedOperationException will be thrown.
compile
in class JdapiModule
fileName
- name of file to compilepublic PlsqlModule clone(java.lang.String newName)
newName
- Name of object that's being createdpublic static PlsqlModule find(java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic java.lang.String getLibraryLocation()
public int getLibrarySource()
public JdapiIterator getAttachedLibraries()
public JdapiIterator getProgramUnits()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |