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

com.ibm.workplace.wcm.api.extensions.authoring
Interface FormContext

public interface FormContext

The FormContext interface provides access to the current Document shown in the authoring interface and the state of the form.

Since:
v8.0

Method Summary
 Document document()
          The Document that will be shown in the Authoring interface
 boolean isFormReadOnly()
          Flag to specify whether the form being viewed in the authoring interface is currently in read or edit mode.
 boolean isNew()
          Flag that the Document opened in the authoring interface has never been saved.
 

Method Detail

document

Document document()
The Document that will be shown in the Authoring interface

Returns:
Document that will be shown in the Authoring interface, never null.

isFormReadOnly

boolean isFormReadOnly()
Flag to specify whether the form being viewed in the authoring interface is currently in read or edit mode.

Returns:
true if the form is in read mode, otherwise false will be returned for a form that is in edit mode.

isNew

boolean isNew()
Flag that the Document opened in the authoring interface has never been saved.

Returns:
true if the Document has never been saved.
Overview  Package   Class  Tree  Serialized  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD