com.plumtree.portalpages.common.helpers
Class ViewHelper

java.lang.Object
  com.plumtree.portalpages.common.helpers.ViewHelper

Direct Known Subclasses:

WSViewHelper

public class ViewHelper
extends java.lang.Object

Author:

adolfoc This class was built for use in generating small collections of HTML for editors that were not appropriate for HTMLConstructs (mostly because they are used in table generation).

Field Summary

static int	INPUTMAXLENGTH_LONG
static int	INPUTMAXLENGTH_SHORT
static int	INPUTSIZE_NONPREFIXED
static int	INPUTSIZE_PREFIXED
static java.lang.String	SPACE
static int	TEXTAREA_COLUMNS
static int	TEXTAREA_ROWS

Constructor Summary

ViewHelper()

Method Summary

static HTMLTableCell	AddCell(HTMLTableRow myRow, java.lang.String colspan) Adds a cell with default view styling to myRow.
static HTMLTableCell	AddEditBoxCell(HTMLTableRow myRow, java.lang.String colspan, java.lang.String sDefaultValue, java.lang.String sHTMLID)
static HTMLTableCell	AddEditBoxCell(HTMLTableRow myRow, java.lang.String colspan, java.lang.String sDefaultValue, java.lang.String sHTMLID, int width)
static HTMLTableCell	AddEditBoxCell(HTMLTableRow myRow, java.lang.String colspan, java.lang.String sDefaultValue, java.lang.String sHTMLID, int width, boolean bIsInputDisabled, java.lang.String sFormID)
static HTMLTableCell	AddEmptyCell(HTMLTableRow myRow, java.lang.String colspan) Adds an empty cell with default view styling to myRow.
static HTMLTableRow	AddEmptyRow(HTMLTable myTable, java.lang.String colspan) Adds an empty row with default view styling to myTable.
static HTMLTableCell	AddIconCell(HTMLTableRow myRow, java.lang.String colspan, int nCLASSID, java.lang.String strProviderCLSID, java.lang.String _strLangID) Adds a Cell with a single object icon in it.
static HTMLTableCell	AddImageCell(HTMLTableRow myRow, java.lang.String colspan, AActivitySpace asOwner, PTImageType imgType) Adds a simple cell containing an image - centered with no border.
static HTMLTableCell	AddIndentCell(HTMLTableRow myRow, java.lang.String colspan)
static HTMLTableCell	AddLabelAndTextCell(HTMLTableRow myRow, java.lang.String colspan, java.lang.String strLabel, java.lang.String strText) Adds a cell to a row containing a bolded label followed on a separate line by text.
static HTMLTableCell	AddLabelCell(HTMLTableRow myRow, java.lang.String colspan, java.lang.String strText) Returns a Cell suitable for long text descriptions.
static int	AddLeftMargin(HTMLTableRow myRow, int nColCount) Uses nColCount to determine if there is enough space for margins and a spacer cell.
static HTMLTable	AddListTable(HTMLElementCollection result) Adds a table with default list view styling to HTMLCollection result.
static HTMLTableCell	AddPasswordBoxCell(HTMLTableRow myRow, java.lang.String colspan, java.lang.String sDefaultValue, java.lang.String sHTMLID)
static HTMLTableCell	AddPasswordBoxCell(HTMLTableRow myRow, java.lang.String colspan, java.lang.String sDefaultValue, java.lang.String sHTMLID, int width)
static void	AddRightMargin(HTMLTableRow myRow, int nColCount) Uses nColCount to determine if there is enough space for margins and a spacer cell.
static HTMLTableRow	AddRow(HTMLTable myTable) Adds a row with default view styling to myTable.
static HTMLTableRow	AddSimpleCheckbox(HTMLTable myTable, int nColCount, java.lang.String strLabel, java.lang.String strHTMLID, java.lang.String strValue, boolean bChecked, java.lang.String strOnChange) Adds a row to myTable containing a simple checkbox selection.
static void	AddSimpleDurationCombo(HTMLTable myTable, int nColCount, java.lang.String strLabel, java.lang.String strHTMLTimeoutInput, java.lang.String strHTMLTimeoutUnitsSelect, PTDuration ptdIn, AActivitySpace asOwner) Adds a label + PTDurationCombo combination to myTable (spanning a single row).
static void	AddSimpleEditBox(HTMLTable myTable, int nColCount, java.lang.String strLabel, java.lang.String strPrefix, java.lang.String sDefaultValue, java.lang.String sHTMLID) Adds a label + edit box combination spanning two rows to myTable.
static void	AddSimpleLabel(HTMLTable myTable, int nColCount, java.lang.String strLabel) Adds a simple Label - full width of the table (adding margins)
static void	AddSimpleNameValue(HTMLTable myTable, int nColCount, java.lang.String strLabel, java.lang.String sDefaultValue, java.lang.String strLang) Adds a row with a simple label: value listing.
static HTMLTableRow	AddSimpleRadio(HTMLTable myTable, int nColCount, java.lang.String strLabel, java.lang.String strHTMLID, java.lang.String strValue, boolean bChecked) Adds a row to myTable containing a simple radio selection.
static HTMLTableRow	AddSimpleRadio(HTMLTable myTable, int nColCount, java.lang.String strLabel, java.lang.String strHTMLID, java.lang.String strValue, boolean bChecked, java.lang.String strOnChange) Adds a row to myTable containing a simple radio selection.
static void	AddSimpleTableHeader(HTMLTable myTable, java.lang.String[] arsHeaders) Adds a simple header (no sorting or whatnot) to an existing table.
static HTMLTableCell	AddSpacerCell(HTMLTableRow myRow, java.lang.String colspan) Adds a cell with default view styling to myRow.
static HTMLSpan	AddSpanToCell(HTMLTableCell myCell) Adds a span with default view styling to myCell.
static HTMLTableCell	AddSubLabelCell(HTMLTableRow myRow, java.lang.String colspan, java.lang.String strText) Returns a Cell suitable for long text descriptions.
static HTMLTable	AddTable(HTMLElementCollection result) Adds a table with default view styling to HTMLCollection result.
static HTMLTableCell	AddTextAreaCell(HTMLTableRow myRow, java.lang.String colspan, java.lang.String sDefaultValue, java.lang.String sHTMLID)
static HTMLTableCell	AddTextCell(HTMLTableRow myRow, java.lang.String colspan, java.lang.String strText) Returns a Cell suitable for long text descriptions.
static HTMLTableCell	AddTypeCell(HTMLTableRow myRow, java.lang.String colspan, int nCLASSID, java.lang.String strProviderCLSID, java.lang.String _strLangID) Adds a Cell with a single Type string (Web Service, etc.) in it.
static java.lang.String	GetAdminFolderPath(IPTSession ptSession, int nAdminFolderID) Returns the String path to the folder with ID nAdminFolderID
static int	GetQRValueAsInt(IASQueryResult ptQR, int nRowIndex, int nPropID) Retrieves an int value from a Query Result.
static java.lang.String	GetQRValueAsString(IASQueryResult ptQR, int nRowIndex, int nPropID) Retrieves a String value from a QueryResult.
static HTMLElement	MakeCreateObjectLink(int nCLASSID, java.lang.String strProviderCLSID, int nFolderID, java.lang.String strLink, AActivitySpace asOwner, java.lang.String strArgs, boolean bCloseWindowOnExit) Makes a simple link that creates an object in the parent window - passing in the added arguments.
static HTMLElement	MakeHiddenInput(java.lang.String strHTMLID, java.lang.String strvalue)
static HTMLTable	MakeListTable() Returns a table with the default view styling.
static HTMLElement	MakeSimpleButton(java.lang.String strText, java.lang.String strOnClick) Makes a simple button with text strText and onClick handler strOnClick.
static HTMLElement	MakeSimpleButton(java.lang.String strText, java.lang.String strOnClick, java.lang.String strHTML) Makes a simple button with text strText and onClick handler strOnClick.
static HTMLElement	MakeSimpleCheckbox(java.lang.String strLabel, java.lang.String strHTMLID, java.lang.String strValue, boolean bChecked, java.lang.String strOnChange) Creates a simple checkbox and returns it.
static HTMLElement	MakeSimpleRadio(java.lang.String strLabel, java.lang.String strHTMLID, java.lang.String strValue, boolean bChecked, java.lang.String strOnChange) Creates a simple radio selection and returns it.
static HTMLTable	MakeTable() Returns a table with the default view styling.
static void	SetRowColor(HTMLTableCell myCell, boolean bRowColor) Sets the cell color based on bRowColor.
static java.lang.String	ValidateNumericInputJS(java.lang.String strFormName, java.lang.String strInputName, java.lang.String strError) Returns JS for validating that a numeric input is, indeed numeric (and positive)

Methods inherited from class java.lang.Object

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

Field Detail

SPACE

public static final java.lang.String SPACE

See Also:

Constant Field Values

INPUTSIZE_PREFIXED

public static final int INPUTSIZE_PREFIXED

See Also:

Constant Field Values

INPUTSIZE_NONPREFIXED

public static final int INPUTSIZE_NONPREFIXED

See Also:

Constant Field Values

TEXTAREA_COLUMNS

public static final int TEXTAREA_COLUMNS

See Also:

Constant Field Values

TEXTAREA_ROWS

public static final int TEXTAREA_ROWS

See Also:

Constant Field Values

INPUTMAXLENGTH_SHORT

public static final int INPUTMAXLENGTH_SHORT

See Also:

Constant Field Values

INPUTMAXLENGTH_LONG

public static final int INPUTMAXLENGTH_LONG

See Also:

Constant Field Values

Constructor Detail

ViewHelper

public ViewHelper()

Method Detail

AddCell

public static HTMLTableCell AddCell(HTMLTableRow myRow,
                                    java.lang.String colspan)

Adds a cell with default view styling to myRow. The cell will span colspan columns.

Parameters:

myRow -

colspan -

Returns:

HTMLTableCell

Throws:

HTMLException

AddEditBoxCell

public static HTMLTableCell AddEditBoxCell(HTMLTableRow myRow,
                                           java.lang.String colspan,
                                           java.lang.String sDefaultValue,
                                           java.lang.String sHTMLID)

Parameters:

myRow -

colspan -

sDefaultValue -

sHTMLID -

Returns:

Throws:

HTMLException

AddEditBoxCell

public static HTMLTableCell AddEditBoxCell(HTMLTableRow myRow,
                                           java.lang.String colspan,
                                           java.lang.String sDefaultValue,
                                           java.lang.String sHTMLID,
                                           int width)

AddEditBoxCell

public static HTMLTableCell AddEditBoxCell(HTMLTableRow myRow,
                                           java.lang.String colspan,
                                           java.lang.String sDefaultValue,
                                           java.lang.String sHTMLID,
                                           int width,
                                           boolean bIsInputDisabled,
                                           java.lang.String sFormID)

AddEmptyCell

public static HTMLTableCell AddEmptyCell(HTMLTableRow myRow,
                                         java.lang.String colspan)

Adds an empty cell with default view styling to myRow. The cell will span colspan columns.

Parameters:

myRow -

colspan -

Returns:

HTMLTableCell

Throws:

HTMLException

AddEmptyRow

public static HTMLTableRow AddEmptyRow(HTMLTable myTable,
                                       java.lang.String colspan)

Adds an empty row with default view styling to myTable. The empty row will span colspan columns.

Parameters:

myTable -

colspan -

Returns:

HTMLTableRow

Throws:

HTMLException

AddIconCell

public static HTMLTableCell AddIconCell(HTMLTableRow myRow,
                                        java.lang.String colspan,
                                        int nCLASSID,
                                        java.lang.String strProviderCLSID,
                                        java.lang.String _strLangID)

Adds a Cell with a single object icon in it.

Parameters:

myRow -

colspan -

nCLASSID -

strProviderCLSID -

Returns:

HTMLTableCell

Throws:

HTMLException

AddTypeCell

public static HTMLTableCell AddTypeCell(HTMLTableRow myRow,
                                        java.lang.String colspan,
                                        int nCLASSID,
                                        java.lang.String strProviderCLSID,
                                        java.lang.String _strLangID)

Adds a Cell with a single Type string (Web Service, etc.) in it.

Parameters:

myRow -

colspan -

nCLASSID -

strProviderCLSID -

Returns:

HTMLTableCell

Throws:

HTMLException

AddIndentCell

public static HTMLTableCell AddIndentCell(HTMLTableRow myRow,
                                          java.lang.String colspan)

Parameters:

myRow -

colspan -

Returns:

Throws:

HTMLException

AddLabelCell

public static HTMLTableCell AddLabelCell(HTMLTableRow myRow,
                                         java.lang.String colspan,
                                         java.lang.String strText)

Returns a Cell suitable for long text descriptions. (no wrapping, bolded, etc)

Parameters:

myRow -

colspan -

strText -

Returns:

HTMLTableCell

Throws:

HTMLException

AddLabelAndTextCell

public static HTMLTableCell AddLabelAndTextCell(HTMLTableRow myRow,
                                                java.lang.String colspan,
                                                java.lang.String strLabel,
                                                java.lang.String strText)

Adds a cell to a row containing a bolded label followed on a separate line by text. The cell will wrap.

Parameters:

myRow -

colspan -

strLabel -

strText -

Throws:

HTMLException

AddSubLabelCell

public static HTMLTableCell AddSubLabelCell(HTMLTableRow myRow,
                                            java.lang.String colspan,
                                            java.lang.String strText)

Returns a Cell suitable for long text descriptions. (no wrapping, etc). The only difference from AddLabelCell is that the label is not bolded.

Parameters:

myRow -

colspan -

strText -

Returns:

HTMLTableCell

Throws:

HTMLException

AddImageCell

public static HTMLTableCell AddImageCell(HTMLTableRow myRow,
                                         java.lang.String colspan,
                                         AActivitySpace asOwner,
                                         PTImageType imgType)

Adds a simple cell containing an image - centered with no border.

Parameters:

myRow -

colspan -

asOwner -

imgType -

Returns:

HTMLTableCell

Throws:

HTMLException

AddLeftMargin

public static int AddLeftMargin(HTMLTableRow myRow,
                                int nColCount)

Uses nColCount to determine if there is enough space for margins and a spacer cell. If so, adds a left margin and returns the count of middle columns (non-margin cells) left for adding inputs.

Parameters:

myRow -

nColCount -

Returns:

int

Throws:

HTMLException

AddPasswordBoxCell

public static HTMLTableCell AddPasswordBoxCell(HTMLTableRow myRow,
                                               java.lang.String colspan,
                                               java.lang.String sDefaultValue,
                                               java.lang.String sHTMLID)

Parameters:

myRow -

colspan -

sDefaultValue -

sHTMLID -

Returns:

Throws:

HTMLException

AddPasswordBoxCell

public static HTMLTableCell AddPasswordBoxCell(HTMLTableRow myRow,
                                               java.lang.String colspan,
                                               java.lang.String sDefaultValue,
                                               java.lang.String sHTMLID,
                                               int width)

AddRightMargin

public static void AddRightMargin(HTMLTableRow myRow,
                                  int nColCount)

Uses nColCount to determine if there is enough space for margins and a spacer cell. If so, adds a right margin and possibly, right spacer. Assumes that the results of AddLeftMargin were respected with regards to remaining column count.

Parameters:

myRow -

nColCount -

Throws:

HTMLException

AddRow

public static HTMLTableRow AddRow(HTMLTable myTable)

Adds a row with default view styling to myTable.

Parameters:

myTable -

Returns:

HTMLTableRow

Throws:

HTMLException

AddSimpleDurationCombo

public static void AddSimpleDurationCombo(HTMLTable myTable,
                                          int nColCount,
                                          java.lang.String strLabel,
                                          java.lang.String strHTMLTimeoutInput,
                                          java.lang.String strHTMLTimeoutUnitsSelect,
                                          PTDuration ptdIn,
                                          AActivitySpace asOwner)

Adds a label + PTDurationCombo combination to myTable (spanning a single row). nColCount is the column count of the table, and ptdDefault contains the default information used to render the PTDurationCombo.

Parameters:

myTable -

nColCount -

strLabel -

strHTMLTimeoutInput -

strHTMLTimeoutUnitsSelect -

ptdIn -

Throws:

java.lang.Exception

AddSimpleEditBox

public static void AddSimpleEditBox(HTMLTable myTable,
                                    int nColCount,
                                    java.lang.String strLabel,
                                    java.lang.String strPrefix,
                                    java.lang.String sDefaultValue,
                                    java.lang.String sHTMLID)

Adds a label + edit box combination spanning two rows to myTable. nColCount is the number of columns in the table (margins will be added if nColCount >= 3). strPrefix is any text that can be prepended to the input box (like the base URL for an gateway input box). sDefaultValue is the value in the input box. sHTMLID is the name of the input box form element.

Parameters:

myTable -

nColCount -

strLabel -

strPrefix -

sDefaultValue -

sHTMLID -

Throws:

HTMLException

AddSimpleLabel

public static void AddSimpleLabel(HTMLTable myTable,
                                  int nColCount,
                                  java.lang.String strLabel)

Adds a simple Label - full width of the table (adding margins)

Parameters:

myTable -

nColCount -

strLabel -

Throws:

HTMLException

AddSimpleNameValue

public static void AddSimpleNameValue(HTMLTable myTable,
                                      int nColCount,
                                      java.lang.String strLabel,
                                      java.lang.String sDefaultValue,
                                      java.lang.String strLang)

Adds a row with a simple label: value listing. Respects the number of columns required as passed in nColCount. nColCount must be 2 or greater.

AddSimpleRadio

public static HTMLTableRow AddSimpleRadio(HTMLTable myTable,
                                          int nColCount,
                                          java.lang.String strLabel,
                                          java.lang.String strHTMLID,
                                          java.lang.String strValue,
                                          boolean bChecked,
                                          java.lang.String strOnChange)

Adds a row to myTable containing a simple radio selection.

Parameters:

myTable -

nColCount -

strLabel -

strHTMLID -

strValue -

bChecked -

strOnChange -

Throws:

HTMLException

AddSimpleCheckbox

public static HTMLTableRow AddSimpleCheckbox(HTMLTable myTable,
                                             int nColCount,
                                             java.lang.String strLabel,
                                             java.lang.String strHTMLID,
                                             java.lang.String strValue,
                                             boolean bChecked,
                                             java.lang.String strOnChange)

Adds a row to myTable containing a simple checkbox selection.

Parameters:

myTable -

nColCount -

strLabel -

strHTMLID -

strValue -

bChecked -

strOnChange -

Throws:

HTMLException

MakeHiddenInput

public static HTMLElement MakeHiddenInput(java.lang.String strHTMLID,
                                          java.lang.String strvalue)

MakeSimpleRadio

public static HTMLElement MakeSimpleRadio(java.lang.String strLabel,
                                          java.lang.String strHTMLID,
                                          java.lang.String strValue,
                                          boolean bChecked,
                                          java.lang.String strOnChange)

Creates a simple radio selection and returns it.

Parameters:

strLabel -

strHTMLID -

strValue -

bChecked -

strOnChange -

Returns:

HTMLElement

Throws:

HTMLException

MakeSimpleCheckbox

public static HTMLElement MakeSimpleCheckbox(java.lang.String strLabel,
                                             java.lang.String strHTMLID,
                                             java.lang.String strValue,
                                             boolean bChecked,
                                             java.lang.String strOnChange)

Creates a simple checkbox and returns it.

Parameters:

strLabel -

strHTMLID -

strValue -

bChecked -

strOnChange -

Returns:

HTMLElement

Throws:

HTMLException

AddSimpleRadio

public static HTMLTableRow AddSimpleRadio(HTMLTable myTable,
                                          int nColCount,
                                          java.lang.String strLabel,
                                          java.lang.String strHTMLID,
                                          java.lang.String strValue,
                                          boolean bChecked)

Adds a row to myTable containing a simple radio selection.

Parameters:

myTable -

nColCount -

strLabel -

strHTMLID -

strValue -

bChecked -

Throws:

HTMLException

AddSimpleTableHeader

public static void AddSimpleTableHeader(HTMLTable myTable,
                                        java.lang.String[] arsHeaders)
                                 throws java.lang.Exception

Adds a simple header (no sorting or whatnot) to an existing table.

Parameters:

myTable -

arsHeaders -

Throws:

java.lang.Exception

AddSpacerCell

public static HTMLTableCell AddSpacerCell(HTMLTableRow myRow,
                                          java.lang.String colspan)

Adds a cell with default view styling to myRow. The cell will span colspan columns. The cell has a width of 100% (can be used to force other cells in the row towards the left margin).

Parameters:

myRow -

colspan -

Returns:

HTMLTableCell

Throws:

HTMLException

AddSpanToCell

public static HTMLSpan AddSpanToCell(HTMLTableCell myCell)

Adds a span with default view styling to myCell.

Parameters:

myCell -

Returns:

HTMLSpan

Throws:

HTMLException

AddTable

public static HTMLTable AddTable(HTMLElementCollection result)

Adds a table with default view styling to HTMLCollection result.

Parameters:

result -

Returns:

HTMLTable

Throws:

HTMLException

AddListTable

public static HTMLTable AddListTable(HTMLElementCollection result)

Adds a table with default list view styling to HTMLCollection result.

Parameters:

result -

Returns:

HTMLTable

Throws:

HTMLException

MakeTable

public static HTMLTable MakeTable()

Returns a table with the default view styling.

Returns:

HTMLTable

Throws:

HTMLException

MakeListTable

public static HTMLTable MakeListTable()

Returns a table with the default view styling.

Returns:

HTMLTable

Throws:

HTMLException

AddTextAreaCell

public static HTMLTableCell AddTextAreaCell(HTMLTableRow myRow,
                                            java.lang.String colspan,
                                            java.lang.String sDefaultValue,
                                            java.lang.String sHTMLID)

Parameters:

myRow -

colspan -

sDefaultValue -

sHTMLID -

Returns:

Throws:

HTMLException

AddTextCell

public static HTMLTableCell AddTextCell(HTMLTableRow myRow,
                                        java.lang.String colspan,
                                        java.lang.String strText)

Returns a Cell suitable for long text descriptions. (wrapping, 100%, etc)

Parameters:

myRow -

colspan -

strText -

Returns:

HTMLTableCell

Throws:

HTMLException

GetAdminFolderPath

public static java.lang.String GetAdminFolderPath(IPTSession ptSession,
                                                  int nAdminFolderID)

Returns the String path to the folder with ID nAdminFolderID

GetQRValueAsInt

public static int GetQRValueAsInt(IASQueryResult ptQR,
                                  int nRowIndex,
                                  int nPropID)

Retrieves an int value from a Query Result.

Parameters:

ptQR -

nRowIndex -

nPropID -

Returns:

int

GetQRValueAsString

public static java.lang.String GetQRValueAsString(IASQueryResult ptQR,
                                                  int nRowIndex,
                                                  int nPropID)

Retrieves a String value from a QueryResult.

Parameters:

ptQR -

nRowIndex -

nPropID -

Returns:

String

MakeCreateObjectLink

public static HTMLElement MakeCreateObjectLink(int nCLASSID,
                                               java.lang.String strProviderCLSID,
                                               int nFolderID,
                                               java.lang.String strLink,
                                               AActivitySpace asOwner,
                                               java.lang.String strArgs,
                                               boolean bCloseWindowOnExit)

Makes a simple link that creates an object in the parent window - passing in the added arguments.

Parameters:

nCLASSID -

strProviderCLSID -

nFolderID -

strLink -

asOwner -

strArgs -

bCloseWindowOnExit -

Returns:

HTMLElement

Throws:

HTMLException

MakeSimpleButton

public static HTMLElement MakeSimpleButton(java.lang.String strText,
                                           java.lang.String strOnClick)

Makes a simple button with text strText and onClick handler strOnClick. Uses the default style for an editor button.

Parameters:

strText -

strOnClick -

Returns:

HTMLElement

Throws:

HTMLException

MakeSimpleButton

public static HTMLElement MakeSimpleButton(java.lang.String strText,
                                           java.lang.String strOnClick,
                                           java.lang.String strHTML)

Makes a simple button with text strText and onClick handler strOnClick. strHTML will be the button name. Uses the default style for an editor button.

Parameters:

strText -

strOnClick -

strHTML -

Returns:

HTMLElement

Throws:

HTMLException

SetRowColor

public static void SetRowColor(HTMLTableCell myCell,
                               boolean bRowColor)

Sets the cell color based on bRowColor. Useful for alternating row colors in table lists.

Parameters:

myCell -

bRowColor -

ValidateNumericInputJS

public static java.lang.String ValidateNumericInputJS(java.lang.String strFormName,
                                                      java.lang.String strInputName,
                                                      java.lang.String strError)

Returns JS for validating that a numeric input is, indeed numeric (and positive)

Parameters:

strFormName -

strInputName -

strError -

Returns:

String