com.plumtree.uiinfrastructure.expandablelist
Class ExpListView

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorView
      com.plumtree.uiinfrastructure.expandablelist.ExpListView

All Implemented Interfaces:

IManagedObject, IMVCObject, IView

Direct Known Subclasses:

AutomationServerListView, CollabExpListView, ExpListPropBrowseView, GbDocTypeExtListView, GbDocTypeListView, GrowableListView, InvCodesListView, KeywordsView, LockboxListView, LocNamesView, MainActivityRightsListView, MigrationDependencyListView, MigrationSelectForImportView, MultiColumnListView, MyCommunitiesListView, ObjPropMapPluginView, PageListView, PropChooserView, PTMultiColumnListView, SelectActivityRightsView, SelectPTObjectView, SiteMapPortletPrefsSortedLinksView, TemplateListView, UserLockListView

public abstract class ExpListView
extends EditorView

This View contains the HTML for the Expandable List Framework.

Author:

Julie Fournier

Field Summary

static java.lang.String	HTMLBUTTON_DELETE JF- HTML Object name: Delete button
static java.lang.String	HTMLCHECKBOX_CHECKALL JF- HTML Object name: Check all checkbox
static java.lang.String	HTMLCHECKBOX_DELROW JF- HTML Object name: Delete row checkbox
static java.lang.String	HTMLHIDDEN_COLUMNID JF- HTML Object name: Column index
static java.lang.String	HTMLHIDDEN_MOVEACTION JF- HTML Object name: Move row action
static java.lang.String	HTMLHIDDEN_ROWINDEX JF- HTML Object name: Row index
static java.lang.String	HTMLID_EXPLIST RWW - HTML ID: Entire Expandable List.
protected int	m_nLastVisibleRow Variable is updated when iterating through rows in Display().

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

m_asOwner, m_model, SPACE

Constructor Summary

ExpListView()

Method Summary

protected void	AddHTMLToActionBar(HTMLTableRow _myRow) Empty method that sub classes can override to add actions to the action bar (like a create object action).
protected boolean	CheckRowIsVisible(int _nRowIndex) Helper method to determine whether or not row is visible.
HTMLElement	Display() Returns the HTML for the View.
HTMLScript	DisplayJavascript() Returns Java Script for goToPage function.
static HTMLElement	GetHiddenInputsForPagination() Returns the HTML to display the hidden inputs needed for the pagination.
protected HTMLTable	GetHTMLBelowActionBar() Returns the HTML for the space below the Action bar.
protected HTMLTable	GetHTMLBelowMainTable() Returns the HTML for the space below the main table, after all rows have been displayed.
protected HTMLTable	GetHTMLForActionBar() Returns the HTML for the Action bar.
protected HTMLTableCell	GetHTMLForAddAction() Returns the HTML for the add cell in the action bar.
protected HTMLTableRow	GetHTMLForAllRowsAdded() The HTML returned by this method will be printed out when all the rows in the list are already added and there are no more rows to add.
protected HTMLTableRow	GetHTMLForBottomRow() Returns the HTML for the last row of the main table.
protected HTMLTableCell	GetHTMLForCheckBox(int _nRowIndex) Returns the HTML for the checkbox on row _nRowIndex.
protected HTMLTableCell	GetHTMLForDeleteAction() Returns the HTML for the delete cell in the action bar.
protected HTMLTableCell	GetHTMLForEmptyCellInActionBar() Helper method for empty cell between actions in the action bar.
protected HTMLTableRow	GetHTMLForEmptyList() The HTML returned by this method will be printed out when the list is empty.
protected HTMLTableCell	GetHTMLForMoveRowActions(int _nRowIndex) Helper method for empty cell between actions in the action bar.
protected HTMLTable	GetHTMLForPaginationLinks(IExpListModelRO _model) Returns the HTML to display the pagination links.
abstract HTMLElement	GetHTMLForRow(IPTGrowableSortedArrayWrapperRO _saData, int _nRowIndex) Will be called for each row.
protected HTMLTableRow	GetHTMLForSubHeader() Returns the HTML for the sub header.
static HTMLScript	GetJavaScriptsForPagination(AActivitySpace _asOwner) Returns the JavaScripts needed for the pagination.
protected void	SetRowStyle(HTMLTableRow _myRow, int _nRowIndex) Helper method to set the style of a row.

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

AddEmptyCellToRow, AddEmptyCellToRow, AddEmptyRowToTable, AddEmptyRowToTable, Create, GetHeaderView, GetHeaderViewHelper, GetName, GetShortSpacerTable, GetSpacerTable, Init

Methods inherited from class java.lang.Object

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

Field Detail

HTMLBUTTON_DELETE

public static final java.lang.String HTMLBUTTON_DELETE

JF- HTML Object name: Delete button

See Also:

Constant Field Values

HTMLCHECKBOX_CHECKALL

public static final java.lang.String HTMLCHECKBOX_CHECKALL

JF- HTML Object name: Check all checkbox

See Also:

Constant Field Values

HTMLCHECKBOX_DELROW

public static final java.lang.String HTMLCHECKBOX_DELROW

JF- HTML Object name: Delete row checkbox

See Also:

Constant Field Values

HTMLHIDDEN_COLUMNID

public static final java.lang.String HTMLHIDDEN_COLUMNID

JF- HTML Object name: Column index

See Also:

Constant Field Values

HTMLHIDDEN_ROWINDEX

public static final java.lang.String HTMLHIDDEN_ROWINDEX

JF- HTML Object name: Row index

See Also:

Constant Field Values

HTMLHIDDEN_MOVEACTION

public static final java.lang.String HTMLHIDDEN_MOVEACTION

JF- HTML Object name: Move row action

See Also:

Constant Field Values

HTMLID_EXPLIST

public static final java.lang.String HTMLID_EXPLIST

RWW - HTML ID: Entire Expandable List.

See Also:

Constant Field Values

m_nLastVisibleRow

protected int m_nLastVisibleRow

Variable is updated when iterating through rows in Display(). Maybe be used in child classes.

Constructor Detail

ExpListView

public ExpListView()

Method Detail

Display

public HTMLElement Display()

Returns the HTML for the View.

Specified by:

Display in interface IView

Specified by:

Display in class EditorView

Returns:

HTMLElement

DisplayJavascript

public HTMLScript DisplayJavascript()

Returns Java Script for goToPage function.

Specified by:

DisplayJavascript in interface IView

Overrides:

DisplayJavascript in class EditorView

Returns:

HTMLScript

See Also:

IView.DisplayJavascript()

GetHTMLForRow

public abstract HTMLElement GetHTMLForRow(IPTGrowableSortedArrayWrapperRO _saData,
                                          int _nRowIndex)

Will be called for each row. Should return the HTML for row _nRowIndex.

Parameters:

_saData -

_nRowIndex -

Returns:

HTMLElement

AddHTMLToActionBar

protected void AddHTMLToActionBar(HTMLTableRow _myRow)

Empty method that sub classes can override to add actions to the action bar (like a create object action).

Parameters:

_myRow - Action bar row object.

CheckRowIsVisible

protected boolean CheckRowIsVisible(int _nRowIndex)

Helper method to determine whether or not row is visible. This method is used by Display().

Parameters:

_nRowIndex -

Returns:

True if row should be displayed, otherwise false.

GetHTMLBelowActionBar

protected HTMLTable GetHTMLBelowActionBar()

Returns the HTML for the space below the Action bar. (The one with the add and delete icons).

Returns:

HTMLTable

GetHTMLForBottomRow

protected HTMLTableRow GetHTMLForBottomRow()

Returns the HTML for the last row of the main table.

Returns:

HTMLTable

GetHTMLBelowMainTable

protected HTMLTable GetHTMLBelowMainTable()

Returns the HTML for the space below the main table, after all rows have been displayed.

Returns:

HTMLTable

GetHTMLForActionBar

protected HTMLTable GetHTMLForActionBar()

Returns the HTML for the Action bar. (The one with the add and delete icons).

Returns:

HTMLTable

GetHTMLForAddAction

protected HTMLTableCell GetHTMLForAddAction()

Returns the HTML for the add cell in the action bar.

Returns:

HTMLTableCell

GetHTMLForCheckBox

protected HTMLTableCell GetHTMLForCheckBox(int _nRowIndex)

Returns the HTML for the checkbox on row _nRowIndex.

Parameters:

_nRowIndex -

Returns:

HTMLTableCell

GetHTMLForDeleteAction

protected HTMLTableCell GetHTMLForDeleteAction()

Returns the HTML for the delete cell in the action bar.

Returns:

HTMLTableCell

GetHTMLForEmptyCellInActionBar

protected HTMLTableCell GetHTMLForEmptyCellInActionBar()

Helper method for empty cell between actions in the action bar.

Returns:

HTMLTableCell

GetHTMLForEmptyList

protected HTMLTableRow GetHTMLForEmptyList()

The HTML returned by this method will be printed out when the list is empty.

Returns:

HTMLTableRow

GetHTMLForAllRowsAdded

protected HTMLTableRow GetHTMLForAllRowsAdded()

The HTML returned by this method will be printed out when all the rows in the list are already added and there are no more rows to add.

Returns:

HTMLTableRow

GetHTMLForPaginationLinks

protected HTMLTable GetHTMLForPaginationLinks(IExpListModelRO _model)

Returns the HTML to display the pagination links.

Returns:

HTMLTable

GetHTMLForMoveRowActions

protected HTMLTableCell GetHTMLForMoveRowActions(int _nRowIndex)

Helper method for empty cell between actions in the action bar.

Returns:

HTMLTableCell

GetHTMLForSubHeader

protected HTMLTableRow GetHTMLForSubHeader()

Returns the HTML for the sub header.

Returns:

HTMLTableRow

SetRowStyle

protected void SetRowStyle(HTMLTableRow _myRow,
                           int _nRowIndex)

Helper method to set the style of a row. This method is used by Display().

Parameters:

_myRow -

_nRowIndex -

GetHiddenInputsForPagination

public static HTMLElement GetHiddenInputsForPagination()

Returns the HTML to display the hidden inputs needed for the pagination. Those inputs have to be displayed only once per page.

Returns:

HTMLElement

GetJavaScriptsForPagination

public static HTMLScript GetJavaScriptsForPagination(AActivitySpace _asOwner)

Returns the JavaScripts needed for the pagination. Those JavaScripts have to be displayed only once per page.

Parameters:

_asOwner -

Returns:

HTMLScript