com.ibm.xsp.actions
Class AbstractDocumentAction

java.lang.Object
  javax.faces.el.MethodBinding
      com.ibm.xsp.binding.MethodBindingEx
          com.ibm.xsp.actions.AbstractDocumentAction

All Implemented Interfaces:

ComponentBindingObject, ValueBindingObject, javax.faces.component.StateHolder

Direct Known Subclasses:

AbstractDocumentConfirmAction, ChangeDocumentModeAction, CreateAttachmentAction, CreateResponseAction, ModifyFieldAction, OpenPageAction, SaveDocumentAction

public abstract class AbstractDocumentAction
extends MethodBindingEx

Field Summary

static java.lang.String	ACTION
static java.lang.String	ACTION_EDIT
static java.lang.String	ACTION_NEW
static java.lang.String	ACTION_OPEN
static java.lang.String	CURRENT_DOCUMENT
static java.lang.String	DOCUMENT
static java.lang.String	DOCUMENT_ID
static java.lang.String	MODE_AUTOEDIT
static java.lang.String	MODE_EDIT
static java.lang.String	MODE_READONLY
static java.lang.String	MODE_TOGGLE
static java.lang.String	PARENT_ID
static java.lang.String	VIEW_ENTRY

Fields inherited from class com.ibm.xsp.binding.MethodBindingEx

ENABLE_SOURCEID

Constructor Summary

AbstractDocumentAction()

Method Summary

protected java.lang.Object	getDocument(javax.faces.context.FacesContext context) Internal helper method to return the current document
static java.lang.Object	getDocument(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String var) Internal helper method to return the current document
protected DocumentAdapter	getDocumentAdapter(javax.faces.context.FacesContext context) Internal helper method to return the current document adapter.
static DocumentAdapter	getDocumentAdapter(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String var) Internal helper method to return the current document adapter.
protected DataSource	getDocumentDataSource(javax.faces.context.FacesContext context) Internal helper method to return the current data source
static DataSource	getDocumentDataSource(javax.faces.context.FacesContext context, java.lang.String var) Internal helper method to return the current data source Will use the var property is it is set, otherwise currentDocument.
java.lang.String	getVar()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object value)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setVar(java.lang.String var)

Methods inherited from class com.ibm.xsp.binding.MethodBindingEx

getComponent, getFacesContext, getParamNames, getParent, getSourceReferenceId, getValueBinding, isTransient, normalizePageName, setComponent, setParamNames, setParent, setSourceReferenceId, setTransient, setValueBinding

Methods inherited from class javax.faces.el.MethodBinding

getExpressionString, getType, invoke

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACTION

public static final java.lang.String ACTION

See Also:

Constant Field Values

DOCUMENT_ID

public static final java.lang.String DOCUMENT_ID

See Also:

Constant Field Values

CURRENT_DOCUMENT

public static final java.lang.String CURRENT_DOCUMENT

See Also:

Constant Field Values

PARENT_ID

public static final java.lang.String PARENT_ID

See Also:

Constant Field Values

DOCUMENT

public static final java.lang.String DOCUMENT

See Also:

Constant Field Values

VIEW_ENTRY

public static final java.lang.String VIEW_ENTRY

See Also:

Constant Field Values

ACTION_NEW

public static final java.lang.String ACTION_NEW

See Also:

Constant Field Values

ACTION_OPEN

public static final java.lang.String ACTION_OPEN

See Also:

Constant Field Values

ACTION_EDIT

public static final java.lang.String ACTION_EDIT

See Also:

Constant Field Values

MODE_EDIT

public static final java.lang.String MODE_EDIT

See Also:

Constant Field Values

MODE_READONLY

public static final java.lang.String MODE_READONLY

See Also:

Constant Field Values

MODE_AUTOEDIT

public static final java.lang.String MODE_AUTOEDIT

See Also:

Constant Field Values

MODE_TOGGLE

public static final java.lang.String MODE_TOGGLE

See Also:

Constant Field Values

Constructor Detail

AbstractDocumentAction

public AbstractDocumentAction()

Method Detail

getVar

public java.lang.String getVar()

Returns:

Returns the value of the var property. Returns null if not set.

setVar

public void setVar(java.lang.String var)

Parameters:

mode - Set the value of the var property.

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class MethodBindingEx

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object value)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class MethodBindingEx

getDocumentAdapter

protected DocumentAdapter getDocumentAdapter(javax.faces.context.FacesContext context)

Internal helper method to return the current document adapter.

getDocumentAdapter

public static DocumentAdapter getDocumentAdapter(javax.faces.context.FacesContext context,
                                                 javax.faces.component.UIComponent component,
                                                 java.lang.String var)

Internal helper method to return the current document adapter.

getDocument

protected java.lang.Object getDocument(javax.faces.context.FacesContext context)

Internal helper method to return the current document

getDocument

public static java.lang.Object getDocument(javax.faces.context.FacesContext context,
                                           javax.faces.component.UIComponent component,
                                           java.lang.String var)

Internal helper method to return the current document

getDocumentDataSource

protected DataSource getDocumentDataSource(javax.faces.context.FacesContext context)

Internal helper method to return the current data source

getDocumentDataSource

public static DataSource getDocumentDataSource(javax.faces.context.FacesContext context,
                                               java.lang.String var)

Internal helper method to return the current data source Will use the var property is it is set, otherwise currentDocument.