|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.iplanet.jato.view.ViewBase | +--com.iplanet.jato.view.ContainerViewBase | +--com.iplanet.jato.view.RequestHandlingViewBase | +--com.iplanet.jato.view.RequestHandlingTreeViewBase
Concrete TreeView implementation that supports request handling and handling of web actions. It is a separate class to support potentially several subclasses that wish to take advantage of this behavior but may differ in other significant ways.
Field Summary | |
static java.lang.String |
DEFAULT_TREE_STATE_DATA_SESSION_ATTRIBUTE_NAME
|
static java.lang.String |
HANDLE_COMMAND_NVP_NAME
|
static java.lang.String |
HANDLE_STATE_NVP_NAME
|
Fields inherited from class com.iplanet.jato.view.RequestHandlingViewBase |
HANDLE_REQUEST_METHOD_PREFIX, HANDLE_REQUEST_METHOD_SUFFIX |
Fields inherited from class com.iplanet.jato.view.ContainerViewBase |
BEGIN_DISPLAY_EVENT_METHOD_PREFIX, BEGIN_DISPLAY_EVENT_METHOD_SUFFIX, END_DISPLAY_EVENT_METHOD_PREFIX, END_DISPLAY_EVENT_METHOD_SUFFIX, eventMethodRegistry, OPTION_ENABLE_QUALIFIELD_CHILD_NAME_LOOKUPS, OPTION_USE_LEGACY_DISPLAY_EVENT_SIGNATURES |
Fields inherited from interface com.iplanet.jato.view.View |
QUALIFIED_VIEW_NAME_SEPARATOR |
Fields inherited from interface com.iplanet.jato.view.WebActionHandler |
DELETE_CONTEXT, EXECUTE_CONTEXT, INSERT_CONTEXT, MODEL_TYPE_DELETE, MODEL_TYPE_EXECUTE, MODEL_TYPE_INSERT, MODEL_TYPE_RETRIEVE, MODEL_TYPE_UPDATE, RETRIEVE_CONTEXT, UPDATE_CONTEXT |
Fields inherited from interface com.iplanet.jato.view.WebActions |
ACTION_CLEAR, ACTION_DELETE, ACTION_EXECUTE, ACTION_FIRST, ACTION_INSERT, ACTION_LAST, ACTION_NEXT, ACTION_PREV, ACTION_PREVIOUS, ACTION_REFRESH, ACTION_SELECT, ACTION_UPDATE |
Constructor Summary | |
|
RequestHandlingTreeViewBase(View parent,
java.lang.String name)
Creates an instance with a parent and name |
protected |
RequestHandlingTreeViewBase(View parent,
java.lang.String name,
java.lang.String stateDataLookupName)
Creates an instance with a parent, name, and state data lookup name. |
Method Summary | |
java.lang.Object |
acceptRequest(javax.servlet.http.HttpServletRequest request)
This method is used by the application servlet to determine if this is the appropriate view to handle the servlet request. |
protected java.lang.Object |
acceptTreeHandleRequest(javax.servlet.http.HttpServletRequest request)
|
int |
getNodeLevel()
|
java.lang.String |
getNodeName()
|
java.lang.String |
getNodeType()
|
TreeModel |
getPrimaryModel()
Returns the primary model used by this model's iteration and navigation logic. |
java.lang.Class |
getPrimaryModelClass()
Returns the primary model class if one has been previously set, or if the primary model instance has been set. |
TreeViewStateData |
getStateData()
|
java.lang.String |
getStateDataLookupName()
Return the state value lookup name. |
java.lang.String |
getTreeHandleChildName()
|
java.lang.Object |
getTreeHandleChildValue()
|
CommandDescriptor |
getTreeHandleCommandDescriptor()
|
java.lang.String |
getTreeHandleStateParameterName()
NOTE: This method is provisional. |
void |
handleRequest(java.lang.Object anInvocation)
Called by the application servlet to have the request handler process this request. |
boolean |
isChildNode()
|
boolean |
isNodeExpanded()
|
boolean |
isParentNode()
|
boolean |
nextNode()
|
void |
requestComplete()
Called to notify the listener that the request is at an end |
void |
resetNodeLocation()
|
void |
setPrimaryModel(TreeModel value)
Sets the primary model used by this model's iteration and navigation logic. |
void |
setPrimaryModelClass(java.lang.Class value)
Sets the class of the primary model, in order to allow later instantiation of the necessary primary model. |
void |
setPrimaryModelClass(java.lang.Class value,
boolean lookInSession,
boolean saveInSession)
Sets the class of the primary model, in order to allow later instantiation of the necessary primary model. |
void |
setRequestContext(RequestContext requestContext)
Sets the current request context. |
protected void |
setStateData(TreeViewStateData value)
|
void |
setStateDataLookupName(java.lang.String value)
Set the state value lookup name |
void |
setTreeHandleCommandDescriptor(CommandDescriptor value)
|
Methods inherited from class com.iplanet.jato.view.ViewBase |
getName, getParent, getParentViewBean, getQualifiedName, getRootView, getRootView, setName, setParent |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.iplanet.jato.view.ContainerView |
beginChildDisplay, beginDisplay, endChildDisplay, endDisplay, getChild, getChildNames, getChildType, getDefaultModel, getDisplayField, getDisplayFieldValue, getNumChildren, mapRequestParameters, resetChildren, setDisplayFieldValue |
Methods inherited from interface com.iplanet.jato.view.View |
getName, getParent, getQualifiedName, setParent |
Field Detail |
public static final java.lang.String HANDLE_COMMAND_NVP_NAME
public static final java.lang.String HANDLE_STATE_NVP_NAME
public static final java.lang.String DEFAULT_TREE_STATE_DATA_SESSION_ATTRIBUTE_NAME
Constructor Detail |
public RequestHandlingTreeViewBase(View parent, java.lang.String name)
parent
- The parent view or null if this view has no parentname
- The logical name of this viewprotected RequestHandlingTreeViewBase(View parent, java.lang.String name, java.lang.String stateDataLookupName)
parent
- The parent view or null if this view has no parentname
- The logical name of this viewstateDataLookupName
- The session attribute name that will be used to lookup this
instance's TreeViewStateData
objectMethod Detail |
public void setRequestContext(RequestContext requestContext)
RequestHandlingViewBase
RequestParticipant
.setRequestContext
in class RequestHandlingViewBase
com.iplanet.jato.view.RequestHandlingViewBase
value
- The request contextpublic void requestComplete()
RequestCompletionListener
requestComplete
in interface RequestCompletionListener
requestComplete
in class RequestHandlingViewBase
public TreeModel getPrimaryModel()
Additionally, if a primary model has not already been set on this view, this method will attempt to create a primary model if the primary model class has been provided.
public void setPrimaryModel(TreeModel value)
value
- This view's primary model, used for iteration through tilesTreeModel
public java.lang.Class getPrimaryModelClass()
public void setPrimaryModelClass(java.lang.Class value)
ModelManager
.
In general, we recommend that developers set the primary model class rather
than a primary model instance during initialization. The primary model class
must implement the com.iplanet.jato.model.TreeModel
interface.The
- primary model classpublic void setPrimaryModelClass(java.lang.Class value, boolean lookInSession, boolean saveInSession)
com.iplanet.jato.model.TreeModel
interface.The
- primary model classpublic java.lang.String getStateDataLookupName()
TreeViewStateData
object.public void setStateDataLookupName(java.lang.String value)
stateDataLookupName
- The session attribute name that will be used to lookup this
instance's TreeViewStateData
objectpublic void resetNodeLocation() throws ModelControlException
resetNodeLocation
in interface TreeView
public boolean nextNode() throws ModelControlException
nextNode
in interface TreeView
public int getNodeLevel() throws ModelControlException
getNodeLevel
in interface TreeView
public java.lang.String getNodeName() throws ModelControlException
getNodeName
in interface TreeView
public java.lang.String getNodeType() throws ModelControlException
getNodeType
in interface TreeView
public boolean isNodeExpanded()
isNodeExpanded
in interface TreeView
public boolean isParentNode()
isParentNode
in interface TreeView
public boolean isChildNode()
isChildNode
in interface TreeView
public java.lang.String getTreeHandleChildName()
getTreeHandleChildName
in interface TreeView
public java.lang.Object getTreeHandleChildValue()
getTreeHandleChildValue
in interface TreeView
public java.lang.String getTreeHandleStateParameterName()
getTreeHandleStateParameterName
in interface TreeView
public java.lang.Object acceptRequest(javax.servlet.http.HttpServletRequest request)
RequestHandler
CommandField
display fields generated this request,
and return an invocation object describing the invocation.acceptRequest
in class RequestHandlingViewBase
com.iplanet.jato.view.RequestHandlingViewBase
handleRequest()
method of this implementation.
This implementation currently returns an instance of
ViewInvocation
.protected java.lang.Object acceptTreeHandleRequest(javax.servlet.http.HttpServletRequest request)
public void handleRequest(java.lang.Object anInvocation) throws java.lang.Exception
RequestHandlingViewBase
Command
specified in the invocation. If a command
is not available from the invocation, a default command will be used
to handle the request (an instance of DefaultRequestHandlingCommand
).There is no need to override this method in implementing classes, though of course, there is no reason one could not. Such a technique may be well suited to single-location security handling, logging, or other tasks.
The expected behavior of the handling method (or this method, if totally
overridden) is to forward the request to another JSP/view bean/resource,
preparing the target in any way necessary to support the request. Note
that the current request context has already been set when this method is
called by virtue of the RequestParticipant
interface, which
this class implements.
handleRequest
in class RequestHandlingViewBase
com.iplanet.jato.view.RequestHandlingViewBase
invocation
- The opaque invocation object previously returned by the
acceptRequest(...)
method. The implementation can store
any information useful to it in this object. This implementation
currently expects this object to be an instance of
ViewInvocation
.Command
,
DefaultRequestHandlingCommand
,
DefaultTiledRequestHandlingCommand
public CommandDescriptor getTreeHandleCommandDescriptor()
public void setTreeHandleCommandDescriptor(CommandDescriptor value)
public TreeViewStateData getStateData()
getStateData
in interface TreeView
protected void setStateData(TreeViewStateData value)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |