com.plumtree.xpshared.htmlconstructs
Class PTBannerType

java.lang.Object
  com.plumtree.xpshared.htmlconstructs.PTConstructType
      com.plumtree.xpshared.htmlconstructs.PTBannerType

public class PTBannerType
extends PTConstructType

Author:

beng The static members of this class provide PTBannerType objects that may be used to obtain constructs from the PTConstructFactory. These constructs describe banners commonly appearing in the portal ui.

A banner is typically a table with a title string, and possibly buttons or other html elements.

Field Summary

static PTBannerType	ADMIN_DIRECTORY_2 Deprecated.
static PTBannerType	BANNER_ACTION_BAR This PTBannerType is to be used for
static PTBannerType	CONTENT_ACCESS_PRIVILEGES Deprecated.
static PTBannerType	DIRECTORY_ACTION_BAR This PTBannerType is to be used for
static PTBannerType	DIRECTORY_CONTENT
static java.lang.String	ELEMENT_NAME_ID_EXPAND_COLLAPSE_CONTAINER Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement that should contain a collapse or expand button.
static java.lang.String	ELEMENT_NAME_ID_EXTENDABLE_CELL Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the banner's extendable cell.
static java.lang.String	ELEMENT_NAME_ID_EXTENDABLE_CELL_2 Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the banner's extendable cell.
static java.lang.String	ELEMENT_NAME_ID_FOLDER_IMG Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the folder image.
static java.lang.String	ELEMENT_NAME_ID_FOLDER_IMG_CONTAINER
static java.lang.String	ELEMENT_NAME_ID_HELP_CONTAINER Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the banner's title.
static java.lang.String	ELEMENT_NAME_ID_RIGHT_SIDE_EXTENDABLE_CELL
static java.lang.String	ELEMENT_NAME_ID_SUBTITLE Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the banner's subtitle.
static java.lang.String	ELEMENT_NAME_ID_TITLE Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the banner's title.
ElementName	EXPAND_COLLAPSE_CONTAINER_ELEMENT_NAME Use this ElementNameto obtain the HTMLElement that should contain a collapse or expand button.
ElementName	EXTENDABLE_CELL_ELEMENT_NAME Use this ElementName ID to obtain the HTMLElement containing the banner's extendable cell.
ElementName	EXTENDABLE_CELL2_ELEMENT_NAME Use this ElementName ID to obtain the HTMLElement containing the banner's secondary extendable cell.
static PTBannerType	FOLDER This PTBannerType is to be used for
ElementName	FOLDER_IMG_CONTAINER_ELEMENT_NAME
ElementName	FOLDER_IMG_ELEMENT_NAME Use this ElementName to obtain the HTMLElement containing the banner folder image.
ElementName	HELP_CONTAINER_ELEMENT_NAME Use this ElementName to obtain the HTMLElement containing the banner's help button.
static PTBannerType	MENU This PTBannerType is to be used for
static PTBannerType	MOST_RECENTLY_USED_EXPANDED Deprecated.
static PTBannerType	NARROW Deprecated.
static PTBannerType	NARROW_2 Deprecated.
static PTBannerType	NARROW_COLLAPSABLE_COLLAPSED Deprecated.
static PTBannerType	NARROW_COLLAPSABLE_EXPANDED Deprecated.
static PTBannerType	OBJECT This PTBannerType is to be used for
static PTBannerType	OBJECT_508 This PTBannerType is to be used for
static PTBannerType	OBJECT_ACTION_BAR This PTBannerType is to be used for
static PTBannerType	OBJECT_ACTION_BAR_CONTENT This PTBannerType is to be used for
static PTBannerType	PORTLET This PTBannerType is to be used for
ElementName	RIGHT_SIDE_EXTENDABLE_CELL_ELEMENT_NAME Use
static PTBannerType	SEARCH_EXPANDED This PTBannerType is to be used for
ElementName	SUBTITLE_ELEMENT_NAME Use this ElementName to obtain the HTMLElement containing the banner's subtitle.
static PTBannerType	TIP_EXPANDED Deprecated.
static PTBannerType	TIPS This PTBannerType is to be used for
ElementName	TITLE_ELEMENT_NAME Use this ElementName to obtain the HTMLElement containing the banner's title.
static PTBannerType	WIDE This PTBannerType is to be used for
static PTBannerType	WIDE_2 Deprecated.
static PTBannerType	WIDE_508 This PTBannerType is to be used for

Fields inherited from class com.plumtree.xpshared.htmlconstructs.PTConstructType

DO_NOT_UPDATE

Method Summary

static IXPEnumerator	GetBannerTypeNames()
java.lang.String	GetDescription()
ElementName	GetElementName()
ElementName	GetElementName(java.lang.String sElementNameID) Call this method to obtain an ElementName object indicating a specific html element found within this construct.
HTMLElement	GetHTMLElement() Call this method to obtain a prototype HTMLElement for this particular construct type.
XPHashtable	GetImgElementNameToAltIdMap() Call this method to obtain a string dictionary mapping element names to img alt id's.
XPHashtable	GetStringMap() Call this method to obtain the string dictionary for this banner type.
static IXPEnumerator	GetTypes() Call this method to obtain an enumeration of all available PTBannerType objects.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

HELP_CONTAINER_ELEMENT_NAME

public ElementName HELP_CONTAINER_ELEMENT_NAME

Use this ElementName to obtain the HTMLElement containing the banner's help button.

FOLDER_IMG_CONTAINER_ELEMENT_NAME

public ElementName FOLDER_IMG_CONTAINER_ELEMENT_NAME

TITLE_ELEMENT_NAME

public ElementName TITLE_ELEMENT_NAME

Use this ElementName to obtain the HTMLElement containing the banner's title.

SUBTITLE_ELEMENT_NAME

public ElementName SUBTITLE_ELEMENT_NAME

Use this ElementName to obtain the HTMLElement containing the banner's subtitle.

FOLDER_IMG_ELEMENT_NAME

public ElementName FOLDER_IMG_ELEMENT_NAME

Use this ElementName to obtain the HTMLElement containing the banner folder image.

EXPAND_COLLAPSE_CONTAINER_ELEMENT_NAME

public ElementName EXPAND_COLLAPSE_CONTAINER_ELEMENT_NAME

Use this ElementNameto obtain the HTMLElement that should contain a collapse or expand button. Banner's do not come from the factory with these buttons, but should be inserted into this element.

EXTENDABLE_CELL_ELEMENT_NAME

public ElementName EXTENDABLE_CELL_ELEMENT_NAME

Use this ElementName ID to obtain the HTMLElement containing the banner's extendable cell. This cell is where you should insert additional buttons etc. Not all banner's have such a cell.

EXTENDABLE_CELL2_ELEMENT_NAME

public ElementName EXTENDABLE_CELL2_ELEMENT_NAME

Use this ElementName ID to obtain the HTMLElement containing the banner's secondary extendable cell. This cell is where you should insert additional buttons etc.

RIGHT_SIDE_EXTENDABLE_CELL_ELEMENT_NAME

public ElementName RIGHT_SIDE_EXTENDABLE_CELL_ELEMENT_NAME

Use

ELEMENT_NAME_ID_RIGHT_SIDE_EXTENDABLE_CELL

public static final java.lang.String ELEMENT_NAME_ID_RIGHT_SIDE_EXTENDABLE_CELL

See Also:

Constant Field Values

ELEMENT_NAME_ID_HELP_CONTAINER

public static final java.lang.String ELEMENT_NAME_ID_HELP_CONTAINER

Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the banner's title.

See Also:

Constant Field Values

ELEMENT_NAME_ID_TITLE

public static final java.lang.String ELEMENT_NAME_ID_TITLE

Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the banner's title.

See Also:

Constant Field Values

ELEMENT_NAME_ID_SUBTITLE

public static final java.lang.String ELEMENT_NAME_ID_SUBTITLE

Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the banner's subtitle.

See Also:

Constant Field Values

ELEMENT_NAME_ID_FOLDER_IMG

public static final java.lang.String ELEMENT_NAME_ID_FOLDER_IMG

Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the folder image.

See Also:

Constant Field Values

ELEMENT_NAME_ID_FOLDER_IMG_CONTAINER

public static final java.lang.String ELEMENT_NAME_ID_FOLDER_IMG_CONTAINER

See Also:

Constant Field Values

ELEMENT_NAME_ID_EXPAND_COLLAPSE_CONTAINER

public static final java.lang.String ELEMENT_NAME_ID_EXPAND_COLLAPSE_CONTAINER

Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement that should contain a collapse or expand button. Banner's do not come from the factory with these buttons, but should be inserted into this element.

See Also:

Constant Field Values

ELEMENT_NAME_ID_EXTENDABLE_CELL

public static final java.lang.String ELEMENT_NAME_ID_EXTENDABLE_CELL

Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the banner's extendable cell. This cell is where you should insert additional buttons etc. Not all banner's have such a cell.

See Also:

Constant Field Values

ELEMENT_NAME_ID_EXTENDABLE_CELL_2

public static final java.lang.String ELEMENT_NAME_ID_EXTENDABLE_CELL_2

Use this ElementName ID to obtain an ElementName from a specific PTBannerType that will allow you to obtain the HTMLElement containing the banner's extendable cell. This cell is where you should insert additional buttons etc. Not all banner's have such a cell.

See Also:

Constant Field Values

NARROW_COLLAPSABLE_EXPANDED

public static final PTBannerType NARROW_COLLAPSABLE_EXPANDED

Deprecated.

This PTBannerType is to be used for

NARROW_COLLAPSABLE_COLLAPSED

public static final PTBannerType NARROW_COLLAPSABLE_COLLAPSED

Deprecated.

This PTBannerType is to be used for

PORTLET

public static final PTBannerType PORTLET

This PTBannerType is to be used for

NARROW

public static final PTBannerType NARROW

Deprecated.

This PTBannerType is to be used for

WIDE

public static final PTBannerType WIDE

This PTBannerType is to be used for

WIDE_508

public static final PTBannerType WIDE_508

This PTBannerType is to be used for

NARROW_2

public static final PTBannerType NARROW_2

Deprecated.

This PTBannerType is to be used for

WIDE_2

public static final PTBannerType WIDE_2

Deprecated.

This PTBannerType is to be used for

SEARCH_EXPANDED

public static final PTBannerType SEARCH_EXPANDED

This PTBannerType is to be used for

TIP_EXPANDED

public static final PTBannerType TIP_EXPANDED

Deprecated.

This PTBannerType is to be used for

ADMIN_DIRECTORY_2

public static final PTBannerType ADMIN_DIRECTORY_2

Deprecated.

This PTBannerType is to be used for

MOST_RECENTLY_USED_EXPANDED

public static final PTBannerType MOST_RECENTLY_USED_EXPANDED

Deprecated.

This PTBannerType is to be used for

CONTENT_ACCESS_PRIVILEGES

public static final PTBannerType CONTENT_ACCESS_PRIVILEGES

Deprecated.

FOLDER

public static final PTBannerType FOLDER

This PTBannerType is to be used for

OBJECT

public static final PTBannerType OBJECT

This PTBannerType is to be used for

OBJECT_508

public static final PTBannerType OBJECT_508

This PTBannerType is to be used for

MENU

public static final PTBannerType MENU

This PTBannerType is to be used for

TIPS

public static final PTBannerType TIPS

This PTBannerType is to be used for

OBJECT_ACTION_BAR

public static final PTBannerType OBJECT_ACTION_BAR

This PTBannerType is to be used for

DIRECTORY_ACTION_BAR

public static final PTBannerType DIRECTORY_ACTION_BAR

This PTBannerType is to be used for

OBJECT_ACTION_BAR_CONTENT

public static final PTBannerType OBJECT_ACTION_BAR_CONTENT

This PTBannerType is to be used for

BANNER_ACTION_BAR

public static final PTBannerType BANNER_ACTION_BAR

This PTBannerType is to be used for

DIRECTORY_CONTENT

public static final PTBannerType DIRECTORY_CONTENT

Method Detail

GetDescription

public java.lang.String GetDescription()

Specified by:

GetDescription in class PTConstructType

Returns:

GetBannerTypeNames

public static IXPEnumerator GetBannerTypeNames()

Returns:

GetTypes

public static IXPEnumerator GetTypes()

Call this method to obtain an enumeration of all available PTBannerType objects.

GetElementName

public ElementName GetElementName()

Returns:

GetHTMLElement

public HTMLElement GetHTMLElement()

Description copied from class: PTConstructType

Call this method to obtain a prototype HTMLElement for this particular construct type. This prototype should neither be used, nor modified, though it may be examined or cloned.

If you wish to obtain an HTMLElement representation of this construct type that is all your own, with which you're free to do as you please, use the PTConstructFactory.GetConstruct() method.

Overrides:

GetHTMLElement in class PTConstructType

Returns:

GetStringMap

public XPHashtable GetStringMap()

Call this method to obtain the string dictionary for this banner type.

A construct's string dictionary contains, as keys, the name's of those html elements that must be updated with localized strings. The values corresponding to these keys are the id's used to obtain the corresponding localized string. For example, if a banner's string dictionary contained one pair of strings:

"title" - "titleID"

then, the element named "title" would need to be updated with the localized string retrieved with the id "titleID".

see PTBannerFactory.GetTableBanner().

Specified by:

GetStringMap in class PTConstructType

Returns:

GetImgElementNameToAltIdMap

public XPHashtable GetImgElementNameToAltIdMap()

Description copied from class: PTConstructType

Call this method to obtain a string dictionary mapping element names to img alt id's. An element name indicates the name of a particular HTMLImg element within this construct. An img alt id indicates the id that may be used to obtain an alt string.

Specified by:

GetImgElementNameToAltIdMap in class PTConstructType

Returns:

GetElementName

public ElementName GetElementName(java.lang.String sElementNameID)

Description copied from class: PTConstructType

Call this method to obtain an ElementName object indicating a specific html element found within this construct.

For example, to obtain an ElementName object indicating the html element containing the wide banner's title, do the following:

myEName = PTBannerType.WIDE.GetElementName( PTBannerType.ELEMENT_NAME_ID_TITLE );

Specified by:

GetElementName in class PTConstructType

Parameters:

sElementNameID - Pass a constant indicating which ElementName you wish to obtain. Each concrete PTConstructType provides a unique set of constants for obtaining ElementName objects.

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns: