Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.netscape.pm.model
Interface IFormElement

All Superinterfaces:
IPMElement
public interface IFormElement
extends IPMElement

Defines an object to provide a set of services built on top of an html form as defined from the builder. An IFormElement object provides:

All of the form elements contained with the Process Manager engine are managed by an object implementing the IFormDictionary interface.

See Also:
IHTMLPage, IPresentationElement, IFormDictionary

Method Summary
 void display(IHTMLPage html, boolean viewOnly)
          Ask the form to display itself and all the fields contained within it at an entry point node.
 void display(IProcessInstance pi, IHTMLPage html, boolean viewOnly)
          Ask the form to display itself and all the fields contained within it at a non-entry point node.
 java.util.Enumeration editables()
          Returns an enumeration of the fields that are present in this form in editable mode.
 java.util.Enumeration fields()
          Returns an enumeration of the fields that are present in this form.
 java.lang.String getBodyTag()
          Returns the entire body tag as defined in the form.
 java.lang.String getHead()
          Returns the content between the <head> tags in the form.
 java.util.Enumeration hidden()
          Returns an enumeration of the fields that are present in this form in hidden mode.
 java.util.Enumeration viewable()
          Returns an enumeration of the fields that are present in this form in viewable mode.
 
Methods inherited from interface com.netscape.pm.model.IPMElement
dumpState, getDescription, getName, getParent, getPrettyName, getProperty, isLocked, lockObject, postCreation, setParent, setProperties, toString
 

Method Detail

fields

public java.util.Enumeration fields()
Returns an enumeration of the fields that are present in this form. The objects returned in the enumeration are of type IPresentationElement.
Returns:
an enumeration of all the fields that are present in the form.
Since:
PAE 4.0
See Also:
IPresentationElement

editables

public java.util.Enumeration editables()
Returns an enumeration of the fields that are present in this form in editable mode. These fields are the ones that have been marked as editable from the builder's form editor tool.

The objects returned in the enumeration are of type IPresentationElement.

Returns:
an enumeration of all the editable fields present in the form.
Since:
PAE 4.0
See Also:
IPresentationElement

hidden

public java.util.Enumeration hidden()
Returns an enumeration of the fields that are present in this form in hidden mode. These fields are the ones that have been marked as hidden from the builder's form editor tool.

The objects returned in the enumeration are of type IPresentationElement.

Returns:
an enumeration of all the hidden fields present in the form.
Since:
PAE 6.5
See Also:
IPresentationElement

viewable

public java.util.Enumeration viewable()
Returns an enumeration of the fields that are present in this form in viewable mode. These fields are the ones that have been marked as viewable from the builder's form editor tool.

The objects returned in the enumeration are of type IPresentationElement.

Returns:
an enumeration of all the viewable fields present in the form.
Since:
PAE 6.5
See Also:
IPresentationElement

getHead

public java.lang.String getHead()
Returns the content between the <head> tags in the form.
Returns:
the contents between the head tags in the form.
Since:
PAE 4.0

getBodyTag

public java.lang.String getBodyTag()
Returns the entire body tag as defined in the form. That is, if the <body> tag in the form has the format: 

 then that is what is returned from this method.








Returns:
the body tag as defined in the form.
Since: 
PAE 4.0

display

public void display(IHTMLPage html,
                    boolean viewOnly)
             throws PMException
Ask the form to display itself and all the fields contained within it at an entry point node. This version of the method display is only called when a client is viewing the field from an entry point form, as no process instance will have been instantiated at that point.

As result of calling this method all of the IPresentationElement objects contained within this form will have their display( IHTMLPage, int, String ) method invoked.

Parameters:
html - the HTML page to be returned to the user
viewOnly - true if the fields in the form should be displayed in view-only mode; false if those fields that have set to display as editable will display themselves in editable mode
Throws:
PMException - if there is a problem with one of the fields displaying itself to the html page.
Since:
NPM 1.0
See Also:
IPresentationElement.display( IHTMLPage, int, String ), IHTMLPage

display

public void display(IProcessInstance pi,
                    IHTMLPage html,
                    boolean viewOnly)
             throws PMException
Ask the form to display itself and all the fields contained within it at a non-entry point node. This version of the method display will be called after the process instance has already been created, that is everywhere but the entry point node.

As result of calling this method all of the IPresentationElement objects contained within this form will have their display( IProcessInstance, IHTMLPage, int, String ) method invoked.

Parameters:
pi - the current process instance
html - the HTML page to be returned to the user
viewOnly - true if the fields in the form should be displayed in view-only mode; false if those fields that have set to display as editable will display themselves in editable mode
Throws:
PMException - if there is a problem with one of the fields displaying itself to the html page.
Since:
NPM 1.0
See Also:
IPresentationElement.display( IProcessInstance, IHTMLPage, int, String ), IHTMLPage, IProcessInstance
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD