com.plumtree.portalpages.common.objects
Class ObjectView

java.lang.Object
  extended by com.plumtree.portalpages.common.objects.ObjectView
All Implemented Interfaces:
IManagedObject, IMVCObject, IView

public class ObjectView
extends java.lang.Object
implements IView

Author:
michaeld

Field Summary
static java.lang.String HTMLINPUT_CHECK_ALL
          HTML Input checkbox: Check All
static java.lang.String JAVASCRIPT_CHECK_ALL
          Javascript Function: checkAll -- matches on substring, not entire name
static java.lang.String JAVASCRIPT_SORT
          Javascript Function: sort
static java.lang.String STR_MVC_CLASS_NAME
          Object Name
 
Constructor Summary
ObjectView()
           
 
Method Summary
 java.lang.Object Create()
          This method is used by the ASManager to return new instances of managed objects.
 HTMLElement Display()
          This method returns the HTMLElement that encompasses the output of the View.
 HTMLScript DisplayJavascript()
          This method returns the HTMLScript that encompasses the Javascript on the page.
 HTMLScriptCollection DisplayJavascriptCollection()
          This method returns a HTMLScriptCollection that encompasses the Javascript from the object view helper.
 HTMLScript GetCheckAllScript()
          Gets the javascript that will check the check all box if all the checkboxes have been checked.
 java.lang.String GetName()
          Return the name of the MVC object.
 IObjectViewHelper GetObjectViewHelper()
          Gets the Object Section Helper for the Object Section.
 void Init(IModelRO model, AActivitySpace parent)
          This method initializes the View with the read only model interface it is supposed to draw it's data from as well as it's parent ActivitySpace (necessary to create URLS).
 void SetObjectViewHelper(IObjectViewHelper objectViewHelper)
          Sets the Object Section Helper for the Object Section to use.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME
Object Name

See Also:
Constant Field Values

JAVASCRIPT_CHECK_ALL

public static final java.lang.String JAVASCRIPT_CHECK_ALL
Javascript Function: checkAll -- matches on substring, not entire name

See Also:
Constant Field Values

JAVASCRIPT_SORT

public static final java.lang.String JAVASCRIPT_SORT
Javascript Function: sort

See Also:
Constant Field Values

HTMLINPUT_CHECK_ALL

public static final java.lang.String HTMLINPUT_CHECK_ALL
HTML Input checkbox: Check All

See Also:
Constant Field Values
Constructor Detail

ObjectView

public ObjectView()
Method Detail

Create

public java.lang.Object Create()
Description copied from interface: IManagedObject
This method is used by the ASManager to return new instances of managed objects.

Specified by:
Create in interface IManagedObject
Returns:
A new instance of the managed class (i.e. return new Foo();)
See Also:
IManagedObject.Create()

Display

public HTMLElement Display()
Description copied from interface: IView
This method returns the HTMLElement that encompasses the output of the View.

Specified by:
Display in interface IView
See Also:
com.plumtree.portaluiinfrastructure.activityspace.IView#Display()

DisplayJavascript

public HTMLScript DisplayJavascript()
This method returns the HTMLScript that encompasses the Javascript on the page. Warning: this may return null, and HTMLScriptCollections may not handle having null added to them.

Specified by:
DisplayJavascript in interface IView
Returns:
HTMLScript
See Also:
IView.DisplayJavascript()

DisplayJavascriptCollection

public HTMLScriptCollection DisplayJavascriptCollection()
This method returns a HTMLScriptCollection that encompasses the Javascript from the object view helper.

Returns:
HTMLScriptCollection

GetName

public java.lang.String GetName()
Description copied from interface: IMVCObject
Return the name of the MVC object.

Specified by:
GetName in interface IMVCObject
Returns:
the name of the object.
See Also:
com.plumtree.portaluiinfrastructure.activityspace.IView#GetName()

Init

public void Init(IModelRO model,
                 AActivitySpace parent)
Description copied from interface: IView
This method initializes the View with the read only model interface it is supposed to draw it's data from as well as it's parent ActivitySpace (necessary to create URLS).

Specified by:
Init in interface IView
See Also:
com.plumtree.portaluiinfrastructure.activityspace.IView#Init(IModelRO, AActivitySpace)

SetObjectViewHelper

public void SetObjectViewHelper(IObjectViewHelper objectViewHelper)
Sets the Object Section Helper for the Object Section to use. The display page must call this method from within the PageDisplay method, before calling display on this view.

Parameters:
objectViewHelper -

GetObjectViewHelper

public IObjectViewHelper GetObjectViewHelper()
Gets the Object Section Helper for the Object Section.

Returns:
IObjectViewHelper

GetCheckAllScript

public HTMLScript GetCheckAllScript()
Gets the javascript that will check the check all box if all the checkboxes have been checked.

Returns:
HTMLScript



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.