com.plumtree.uiinfrastructure.statichelpers
Class HTMLConstructHelpers

java.lang.Object
  com.plumtree.uiinfrastructure.statichelpers.HTMLConstructHelpers

public class HTMLConstructHelpers
extends java.lang.Object

Field Summary

static java.lang.String	STR_508_HELP_DIR
static java.lang.String	STR_STANDARD_HELP_DIR

Constructor Summary

HTMLConstructHelpers()

Method Summary

static java.lang.String	Get508HelpBaseUrl(AActivitySpace sp)
static java.lang.String	Get508HelpUrl(AActivitySpace sp)
static HTMLElement	GetActionBar(HTMLElementCollection myElements, java.lang.String strViewName, AActivitySpace sp) Returns an "Action Bar" banner, an HTMLTable of style actionbar_object containing an arbitrary number of "buttons" (HTMLAnchors with images and text attached) or other HTMLElements.
static HTMLAnchor	GetActionBarAnchor(int intAddOrCreate, HTMLImg myImage, java.lang.String strImageAlt, java.lang.String strButtonText, java.lang.String strOnClick, AActivitySpace sp) This function returns an Action Bar "button", which is an HTMLAnchor with images, text, and an onclick event attached.
static HTMLAnchor	GetHelpAnchor(AActivitySpace sp)
static HTMLAnchor	GetHelpAnchor(AActivitySpace sp, HTMLElement innerElement, java.lang.String strHelpHint)
static java.lang.String	GetHelpTopic(AActivitySpace sp)
static java.lang.String	GetHelpUrlForXUIPage(AActivitySpace sp)
static java.lang.String	GetPreviousSpaceURL(AActivitySpace asOwner) This helper method determines the appropriate previous request URL to go pack to the previous page.
static java.lang.String	GetRoboHelpBaseUrl(AActivitySpace sp)
static HTMLElement	GetSubHeader(java.lang.String strText, AActivitySpace sp)

Methods inherited from class java.lang.Object

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

Field Detail

STR_508_HELP_DIR

public static final java.lang.String STR_508_HELP_DIR

See Also:

Constant Field Values

STR_STANDARD_HELP_DIR

public static final java.lang.String STR_STANDARD_HELP_DIR

See Also:

Constant Field Values

Constructor Detail

HTMLConstructHelpers

public HTMLConstructHelpers()

Method Detail

GetSubHeader

public static HTMLElement GetSubHeader(java.lang.String strText,
                                       AActivitySpace sp)

Get508HelpBaseUrl

public static java.lang.String Get508HelpBaseUrl(AActivitySpace sp)

GetRoboHelpBaseUrl

public static java.lang.String GetRoboHelpBaseUrl(AActivitySpace sp)

GetHelpTopic

public static java.lang.String GetHelpTopic(AActivitySpace sp)

Get508HelpUrl

public static java.lang.String Get508HelpUrl(AActivitySpace sp)

GetHelpUrlForXUIPage

public static java.lang.String GetHelpUrlForXUIPage(AActivitySpace sp)

GetHelpAnchor

public static HTMLAnchor GetHelpAnchor(AActivitySpace sp)

GetHelpAnchor

public static HTMLAnchor GetHelpAnchor(AActivitySpace sp,
                                       HTMLElement innerElement,
                                       java.lang.String strHelpHint)

GetActionBarAnchor

public static HTMLAnchor GetActionBarAnchor(int intAddOrCreate,
                                            HTMLImg myImage,
                                            java.lang.String strImageAlt,
                                            java.lang.String strButtonText,
                                            java.lang.String strOnClick,
                                            AActivitySpace sp)

This function returns an Action Bar "button", which is an HTMLAnchor with images, text, and an onclick event attached. The first parameter specifies whether the button will have no (0), an Add (1), or a Create (2) image just to the left of the main image, typically the icon of the object being added or created.

Parameters:

intAddOrCreate - - 0 for none, 1 for Add, 2 for Create

myImage - - The image to appear on the button

strImageAlt - - The alt tag to be associated with the above image

strButtonText - - The text to appear on the button

strOnClick - - The on click function to be attached to the button

sp - - The activity space from whence this function was invoked

Returns:

HTMLAnchor

GetActionBar

public static HTMLElement GetActionBar(HTMLElementCollection myElements,
                                       java.lang.String strViewName,
                                       AActivitySpace sp)

Returns an "Action Bar" banner, an HTMLTable of style actionbar_object containing an arbitrary number of "buttons" (HTMLAnchors with images and text attached) or other HTMLElements. The Elements are passed in as an collection, along with the view name and activity space where this banner will be displayed

Parameters:

myElements - - An array of pre-constructed HTMLElements

strViewName - - The name of the view where this banner will be displayed

sp - - The activity space this banner will reside in

Returns:

HTMLElement

GetPreviousSpaceURL

public static java.lang.String GetPreviousSpaceURL(AActivitySpace asOwner)

This helper method determines the appropriate previous request URL to go pack to the previous page. This will just go directly to the previous space if the last request was a POST. This method assumes that you are switching between Activity Spaces. It does not work well if you want to go back to the previous URL in the same space. This can also be a problem if the user refreshes the page, as this link will then point to the current space.

Parameters:

asOwner -

Returns:

String URL to go back to