com.plumtree.uiinfrastructure.tree
Class AStartTreeControl

java.lang.Object
  com.plumtree.uiinfrastructure.tree.AStartTreeControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

Direct Known Subclasses:

ActivityRightsStartTreeControl, CredVaultStartTreeControl, GlobalObjsStartTreeControl, ServerStartTreeControl, StartTreeControl, UserInfoStartTreeControl

public abstract class AStartTreeControl
extends java.lang.Object
implements IControl

This abstract class handles setting most of the portal independent variables on the ITreeModel when a new tree is started.

Author:

Don Hayler

Field Summary

static java.lang.String	ACTIONSUBTITLE The action sub-title of the tree
static java.lang.String	ALLOW_EMPTY_SUBMISSION Allow users to click finish on a tree with nothing selected.
static java.lang.String	CLASS_IDS_TO_DISPLAY The class IDs of the types of objects you want to display.
static java.lang.String	DISPLAYED_ITEMS classID1,objectID1,classID2,objectID2,etc...
static java.lang.String	HELP_TOPIC The help topic.
static java.lang.String	HIDDEN_ITEMS classID1,objectID1,classID2,objectID2,etc...
protected ITreeModel	m_asModel Internal data
protected ATreeAS	m_asOwner
static java.lang.String	MULTI_SELECT true = check boxes, false = radio buttons (multi select vs.
static java.lang.String	ONCLICK_CALL The name of the javascript function in the parent page to call when tree elements are clicked.
static java.lang.String	PARENT_FORM_NAME These two should be used together or not at all.
static java.lang.String	PARENT_FORM_SPACE_ID The name of the input in the parent form that you would like the AActivitySpace ID of the tree space put into.
static java.lang.String	PARENT_SUBMIT_CALL The name of the javascript function in the parent page to call when the tree is submitted.
static java.lang.String	SELECT_MODE See TreeConstants for select modes (leaves vs.
static java.lang.String	SELECT_OPTIONS See TreeConstants for select options (strict leaves).
static java.lang.String	SELECTED_ITEMS classID1,objectID1,classID2,objectID2,etc...
static java.lang.String	SHOW_ROOT This determines whether or not the root folder will be displayed.
static java.lang.String	SUBMIT_MODE See TreeConstants for select modes (server vs.
static java.lang.String	TITLE The title of the tree pop-up

Constructor Summary

AStartTreeControl()

Method Summary

Redirect	CheckActionSecurityAndExecute(XPHashtable arguments) Execute the control business logic and optionally return a Redirect object pointing to another AActivitySpace.
abstract java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
abstract java.lang.String	GetName() Return the name of the MVC object.
void	Init(IModel model, AActivitySpace space) Initialize the control with the model it should use and it's parent AActivitySpace.

Methods inherited from class java.lang.Object

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

Field Detail

MULTI_SELECT

public static final java.lang.String MULTI_SELECT

true = check boxes, false = radio buttons (multi select vs. single select of objects)

See Also:

Constant Field Values

SELECT_MODE

public static final java.lang.String SELECT_MODE

See TreeConstants for select modes (leaves vs. folders vs. both)

See Also:

Constant Field Values

SELECT_OPTIONS

public static final java.lang.String SELECT_OPTIONS

See TreeConstants for select options (strict leaves). Optional.

See Also:

Constant Field Values

CLASS_IDS_TO_DISPLAY

public static final java.lang.String CLASS_IDS_TO_DISPLAY

The class IDs of the types of objects you want to display. If you don't want to display any objects (folders only), don't use this. Make sure to include catalogfolder if you want catalogfolders, otherwise only folders will appear.

See Also:

Constant Field Values

SELECTED_ITEMS

public static final java.lang.String SELECTED_ITEMS

classID1,objectID1,classID2,objectID2,etc...

See Also:

Constant Field Values

HIDDEN_ITEMS

public static final java.lang.String HIDDEN_ITEMS

classID1,objectID1,classID2,objectID2,etc... This will display all objects except for the following

See Also:

Constant Field Values

DISPLAYED_ITEMS

public static final java.lang.String DISPLAYED_ITEMS

classID1,objectID1,classID2,objectID2,etc... This will only display the selected objects. This does not work for IPTFolders. The class IDs still need to be specified and the root folder ID needs to be specified, even though it will be ignored. Normal folder browsing will be ignored

See Also:

Constant Field Values

SHOW_ROOT

public static final java.lang.String SHOW_ROOT

This determines whether or not the root folder will be displayed. By default, it will be displayed. Pass in true or false.

See Also:

Constant Field Values

SUBMIT_MODE

public static final java.lang.String SUBMIT_MODE

See TreeConstants for select modes (server vs. Javascript)

See Also:

Constant Field Values

PARENT_FORM_NAME

public static final java.lang.String PARENT_FORM_NAME

These two should be used together or not at all. The name of the parent form that you would like the data passed back to.

See Also:

Constant Field Values

PARENT_FORM_SPACE_ID

public static final java.lang.String PARENT_FORM_SPACE_ID

The name of the input in the parent form that you would like the AActivitySpace ID of the tree space put into. This is used to reopen the tree after it has been created.

See Also:

Constant Field Values

PARENT_SUBMIT_CALL

public static final java.lang.String PARENT_SUBMIT_CALL

The name of the javascript function in the parent page to call when the tree is submitted. This should not include the '();'. In Javascript submit mode this method should take an array argument which will be made up of objects with name, ObjectID, and ClassID member variables. see ATreeAS for details. Warning: this array will dissapear after the function call is over. If you want to save the items, you must copy them somewhere in your page. The names of the objects will be HTMLEncoded and truncated to 50 characters.

See Also:

Constant Field Values

ONCLICK_CALL

public static final java.lang.String ONCLICK_CALL

The name of the javascript function in the parent page to call when tree elements are clicked. This should include the whole path to the function (i.e. parent.myframe.myfunction) without the ending parentheses or semicolon '();'. This should not include the '();'. This function will be called with the clicked input as the only argument in the onclick method of the tree items. It should return true or false depending on whether or not the button should be clicked (true implies it will be clicked, false implies it will not). The function name should also not contain {,},',",\ Using this method will turn off dynamic updating of the 'you have selected' frame, which uses the same mechanism. This should be used extremely sparingly (only in the save page currently).

See Also:

Constant Field Values

TITLE

public static final java.lang.String TITLE

The title of the tree pop-up

See Also:

Constant Field Values

ACTIONSUBTITLE

public static final java.lang.String ACTIONSUBTITLE

The action sub-title of the tree

See Also:

Constant Field Values

ALLOW_EMPTY_SUBMISSION

public static final java.lang.String ALLOW_EMPTY_SUBMISSION

Allow users to click finish on a tree with nothing selected. default is false

See Also:

Constant Field Values

HELP_TOPIC

public static final java.lang.String HELP_TOPIC

The help topic.

See Also:

Constant Field Values

m_asOwner

protected ATreeAS m_asOwner

m_asModel

protected ITreeModel m_asModel

Internal data

Constructor Detail

AStartTreeControl

public AStartTreeControl()

Method Detail

CheckActionSecurityAndExecute

public Redirect CheckActionSecurityAndExecute(XPHashtable arguments)

Description copied from interface: IControl

Execute the control business logic and optionally return a Redirect object pointing to another AActivitySpace. Returning null means that the user should return to the parent AActivitySpace's current page. This method is designed to check that the user has access to perform the actions with the given parameters. If the user does not, a redirect object which has had Redirect.SetRedirectToLogin(true) called on it. If the user is the Guest, this will bounce to the login page and back to the Redirect after the user has logged on. If the user is already logged on, they will be redirected to an error page. In general, the error redirect that is returned should contain all of the query string parameters that made up the URL that originally led to the control. Checking whether or not a particular user ever has any access to the space, page, and control should be done in IPTActivitySpace.CheckBasicAccess().

Specified by:

CheckActionSecurityAndExecute in interface IControl

Returns:

Redirect where to redirect to after the control is finished executing. This will go to the login page or an error page if Redirect.SetRedirectToLogin(true) has been called.

See Also:

com.plumtree.uiinfrastructure.activityspace.IControl#Execute()

Init

public void Init(IModel model,
                 AActivitySpace space)

Description copied from interface: IControl

Initialize the control with the model it should use and it's parent AActivitySpace. This method needs to be called before any other methods. This method also clears all internal data so the control can be used again without fear of mixing data.

Specified by:

Init in interface IControl

See Also:

IControl.Init(IModel, AActivitySpace)

Create

public abstract java.lang.Object Create()

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();)

GetName

public abstract 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.xpshared.activityspace.IMVCObject#GetName()