com.plumtree.portalpages.admin.editors.savedsearch
Class SavSrchMainDP

java.lang.Object
  com.plumtree.uiinfrastructure.form.AFormDP
      com.plumtree.uiinfrastructure.editor.EditorDP
          com.plumtree.portalpages.admin.editors.savedsearch.SavSrchMainDP

All Implemented Interfaces:

IDisplayPage, IMVCObject

public class SavSrchMainDP
extends EditorDP

Author:

MikeS

Field Summary

static java.lang.String	HTMLCHECKBOX_ADMINFOLDER Checkbox name for the folders
static java.lang.String	HTMLCHECKBOX_CATALOGFOLDER Checkbox name for the folders
static java.lang.String	HTMLCHECKBOX_CHECKALL Checkbox to be displayed in the subheader of the Add Folders toolabar
static java.lang.String	HTMLHIDDEN_ADMSPACEID Hidden HTML field for the Admin folder activity space id
static java.lang.String	HTMLHIDDEN_CATSPACEID Hidden HTML field for the catalog activity space id
static java.lang.String	HTMLHIDDEN_FOLDERSELECTED Hidden HTML field for the catalog folder selected
static java.lang.String	HTMLHIDDEN_TREEREPOST Hidden HTML for the tree repost action
static java.lang.String	JAVASCRIPT_ADMINFOLDERTREE Admin folder open javascript function name
static java.lang.String	JAVASCRIPT_CATALOGFOLDERTREE Catalog folder open javascript function name
protected PTStyleClass	m_styleListItem
static java.lang.String	STR_MVC_CLASS_NAME
static java.lang.String	strCardLanguagePlugInKey
static java.lang.String	UPDATE_ALERT_JS javascript name for function that alerts user of portlet cache

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorDP

m_asOwner

Fields inherited from class com.plumtree.uiinfrastructure.form.AFormDP

GET, HTMLFORM_NAME, JAVASCRIPT_SETUP_FOR_SUBMIT_TO_CONTROL, JAVASCRIPT_SUBMIT_FORM, JAVASCRIPT_SUBMIT_TO_CONTROL, MULTIPART_ENCODING, POST

Constructor Summary

SavSrchMainDP()

Method Summary

void	DisplayFolderList(HTMLTableCell foldercell, int type) Displays a list of selected folders, admin or catalog
protected void	DisplayFolderListHeader(HTMLTable myTable, int classid) Display the header row for a list of folders
protected void	DisplayFolderListItem(HTMLTable myTable, int id, java.lang.String name, java.lang.String path, int intType) Display a single item in a list of folders
HTMLElementCollection	DisplayHTMLBeforeForm() Displays some HTML after the body tag and before the form tag.
protected HTMLScriptCollection	DisplayJavaScriptFromChild() Display javascript for this display page
protected java.lang.String[]	GetFolderNameAndPath(int id, int type) Get the folder name based on ID and type
protected HTMLElement	GetHTMLBelowSubHeader() Implement this method to add HTML below the sub header.
HTMLImg	GetImage(PTImageType type, java.lang.String alt, java.lang.String w, java.lang.String h) Helper function for retrieving images from the construct factory
java.lang.String	GetLeftNavString() Returns the String to display on the left navigation menu, linking to that page.
protected ISavedSearchModelRO	GetModel() Returns the read-only model
java.lang.String	GetName() Returns the Class name.
HTMLElement	PageDisplay() Returns the HTML for the General Info page.
protected PTObjectIdNamePair[]	SortObjectByName(XPArrayList ids, int type, boolean ascending) Helper function for sorting

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorDP

AddScriptToHead, CreateContentTable, CreateLeftNavBar, GetEditorHeaderViewName, GetFormTitle, GetOwner, GetPageTitle, Init, SetContentTableCellSpacing

Methods inherited from class com.plumtree.uiinfrastructure.form.AFormDP

AddToValidationFunction, Display, DisplayForm, DisplayHTMLAfterForm, DisplayHTMLinHEAD, DisplayJavascript, Get508RepostURL, GetCloseOnCancel, GetFormPageType, GetOnLoad, GetRepostControlName, GetRepostTypeIsPost, GetStatusViewEnabled, GetStatusViewRepostValues, GetUseJavascript, GetWindowFocusEnabled, InsertJavascriptBeforeFormSubmit, PartialContentDisplay, RemoveFromValidationFunction, SetMultiPartEncoding, SetShow508FormFooter, SetStatusViewEnabled, SetStatusViewRepostValues

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

See Also:

Constant Field Values

UPDATE_ALERT_JS

public static final java.lang.String UPDATE_ALERT_JS

javascript name for function that alerts user of portlet cache

See Also:

Constant Field Values

strCardLanguagePlugInKey

public static final java.lang.String strCardLanguagePlugInKey

See Also:

Constant Field Values

HTMLCHECKBOX_CATALOGFOLDER

public static final java.lang.String HTMLCHECKBOX_CATALOGFOLDER

Checkbox name for the folders

See Also:

Constant Field Values

HTMLCHECKBOX_ADMINFOLDER

public static final java.lang.String HTMLCHECKBOX_ADMINFOLDER

Checkbox name for the folders

See Also:

Constant Field Values

HTMLCHECKBOX_CHECKALL

public static final java.lang.String HTMLCHECKBOX_CHECKALL

Checkbox to be displayed in the subheader of the Add Folders toolabar

See Also:

Constant Field Values

HTMLHIDDEN_CATSPACEID

public static final java.lang.String HTMLHIDDEN_CATSPACEID

Hidden HTML field for the catalog activity space id

See Also:

Constant Field Values

HTMLHIDDEN_ADMSPACEID

public static final java.lang.String HTMLHIDDEN_ADMSPACEID

Hidden HTML field for the Admin folder activity space id

See Also:

Constant Field Values

HTMLHIDDEN_TREEREPOST

public static final java.lang.String HTMLHIDDEN_TREEREPOST

Hidden HTML for the tree repost action

See Also:

Constant Field Values

JAVASCRIPT_CATALOGFOLDERTREE

public static final java.lang.String JAVASCRIPT_CATALOGFOLDERTREE

Catalog folder open javascript function name

See Also:

Constant Field Values

JAVASCRIPT_ADMINFOLDERTREE

public static final java.lang.String JAVASCRIPT_ADMINFOLDERTREE

Admin folder open javascript function name

See Also:

Constant Field Values

HTMLHIDDEN_FOLDERSELECTED

public static final java.lang.String HTMLHIDDEN_FOLDERSELECTED

Hidden HTML field for the catalog folder selected

See Also:

Constant Field Values

m_styleListItem

protected PTStyleClass m_styleListItem

Constructor Detail

SavSrchMainDP

public SavSrchMainDP()

Method Detail

DisplayHTMLBeforeForm

public HTMLElementCollection DisplayHTMLBeforeForm()

Displays some HTML after the body tag and before the form tag. For example this is used by pages using a DHTML calendar to display the div tag. The function is optional. If it exists, it will be called by the framework, and the resulting HTMLElement will be added in the right place.

Overrides:

DisplayHTMLBeforeForm in class EditorDP

Returns:

HTMLElement

See Also:

AFormDP.DisplayHTMLBeforeForm()

GetLeftNavString

public java.lang.String GetLeftNavString()

Returns the String to display on the left navigation menu, linking to that page.

Specified by:

GetLeftNavString in class EditorDP

Returns:

String

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorDP

Returns:

String

See Also:

IMVCObject.GetName()

GetHTMLBelowSubHeader

protected HTMLElement GetHTMLBelowSubHeader()

Implement this method to add HTML below the sub header.

Overrides:

GetHTMLBelowSubHeader in class EditorDP

Returns:

HTMLElement

Throws:

HTMLException

PageDisplay

public HTMLElement PageDisplay()

Returns the HTML for the General Info page.

Overrides:

PageDisplay in class EditorDP

Returns:

HTMLElement

See Also:

com.plumtree.uiinfrastructure.activityspace.AFormDP#PageDisplay(HTMLTableRow)

DisplayJavaScriptFromChild

protected HTMLScriptCollection DisplayJavaScriptFromChild()

Display javascript for this display page

Overrides:

DisplayJavaScriptFromChild in class EditorDP

Returns:

Throws:

HTMLException

DisplayFolderList

public void DisplayFolderList(HTMLTableCell foldercell,
                              int type)

Displays a list of selected folders, admin or catalog

Parameters:

foldercell - The cell to display the folders in

type - The type of folder to display

Throws:

HTMLException

DisplayFolderListHeader

protected void DisplayFolderListHeader(HTMLTable myTable,
                                       int classid)

Display the header row for a list of folders

Parameters:

myTable - The table to display the header in

classid - The type of folder

Throws:

HTMLException

DisplayFolderListItem

protected void DisplayFolderListItem(HTMLTable myTable,
                                     int id,
                                     java.lang.String name,
                                     java.lang.String path,
                                     int intType)

Display a single item in a list of folders

Parameters:

myTable - The table being manipulated

id - The id of the folder

name - The name of the folder

intType - = The classid of the folder type

Throws:

HTMLException

GetModel

protected ISavedSearchModelRO GetModel()

Returns the read-only model

Returns:

ISavedSearchModelRO

GetImage

public HTMLImg GetImage(PTImageType type,
                        java.lang.String alt,
                        java.lang.String w,
                        java.lang.String h)

Helper function for retrieving images from the construct factory

Parameters:

type - PTImageType

alt - String

w - width - String

h - height - String

Returns:

HTMLImg

SortObjectByName

protected PTObjectIdNamePair[] SortObjectByName(XPArrayList ids,
                                                int type,
                                                boolean ascending)

Helper function for sorting

Parameters:

ids - ID of folders being manipulated

type - The type of folder

ascending - Ascending or descending

Returns:

PTObjectIDNamePair[]

GetFolderNameAndPath

protected java.lang.String[] GetFolderNameAndPath(int id,
                                                  int type)

Get the folder name based on ID and type

Parameters:

id - The ID of the folder

type - The type of the folder

Returns: