Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.scopemvc.view.servlet
Class ServletView  view ServletView download ServletView.java

java.lang.Object
  extended byorg.scopemvc.view.servlet.ServletView
All Implemented Interfaces:
org.scopemvc.core.View

public class ServletView
extends java.lang.Object
implements org.scopemvc.core.View

A container View to aggregate a set of Pages the allows the currently visible Page to be set.

In a servlet application, a Controller's View must 'contain' all the possible pages that the user could be interacting with because the user is free to hit the browser's forward and back buttons, use history or bookmarks etc. This "View" therefore acts as a simple container for other Views (Pages) that represent the actual interfaces that the user interacts with. It forwards any setController(org.scopemvc.core.Controller) 55 and setBoundModel(java.lang.Object) 55 calls to all children.

A Controller in a web application must create an instance of ServletView to put all its possible Pages into using addPage(org.scopemvc.view.servlet.Page) 55 . The Controller then setView() establishes the container as the Controller's View. To determine the Page that is shown to the user on showView, call setVisible(java.lang.String) 55 with the Page ID.

Version:
$Revision: 1.7 $ $Date: 2002/01/27 12:01:06 $

Field Summary
private  org.scopemvc.core.Controller controller
          Parent Controller for this View and all child Pages.
private static org.apache.commons.logging.Log LOG
           
private  java.lang.Object model
          Bound model for this View and all child Pages.
protected  java.util.List pages
          The child Pages this ServletView contains.
private  Page visible
          The subview that is "visible".
 
Constructor Summary
ServletView()
          Create a container for the Pages that a Controller manages.
 
Method Summary
 void addPage(Page inPage)
           
 Page findPageByID(java.lang.String inViewID)
           
 java.lang.Object getBoundModel()
           
 org.scopemvc.core.Controller getController()
           
 Page getFirstPage()
          Used by ScopeServlet.findDefaultPage .
 Page getVisible()
           
 void issueControl(org.scopemvc.core.Control inControl)
          Note that ServletViews inherit their parent's Controller.
 void setBoundModel(java.lang.Object inModel)
          The passed model is bound to this view and to all children ServletViews as well.
 void setController(org.scopemvc.core.Controller inController)
          The parent Controller must register itself with the ServletView via this method in order to receive Controls from it.
 void setVisible(java.lang.String inViewID)
           
 java.lang.String toString()
          For debug.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

pages

protected java.util.List pages
The child Pages this ServletView contains.


visible

private Page visible
The subview that is "visible". ie the Page that will streamView to the user.


controller

private org.scopemvc.core.Controller controller
Parent Controller for this View and all child Pages.


model

private java.lang.Object model
Bound model for this View and all child Pages.

Constructor Detail

ServletView

public ServletView()
Create a container for the Pages that a Controller manages.

Method Detail

getBoundModel

public final java.lang.Object getBoundModel()
Specified by:
getBoundModel in interface org.scopemvc.core.View

setBoundModel

public final void setBoundModel(java.lang.Object inModel)
The passed model is bound to this view and to all children ServletViews as well.

Specified by:
setBoundModel in interface org.scopemvc.core.View

setController

public final void setController(org.scopemvc.core.Controller inController)
The parent Controller must register itself with the ServletView via this method in order to receive Controls from it.

Specified by:
setController in interface org.scopemvc.core.View

getController

public final org.scopemvc.core.Controller getController()
Specified by:
getController in interface org.scopemvc.core.View

issueControl

public final void issueControl(org.scopemvc.core.Control inControl)
Note that ServletViews inherit their parent's Controller.

Specified by:
issueControl in interface org.scopemvc.core.View

addPage

public final void addPage(Page inPage)

getFirstPage

public final Page getFirstPage()
Used by ScopeServlet.findDefaultPage .


setVisible

public final void setVisible(java.lang.String inViewID)

getVisible

public final Page getVisible()

findPageByID

public final Page findPageByID(java.lang.String inViewID)

toString

public java.lang.String toString()
For debug.