PTButtonType (Plumtree 6.1 Portal UI API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.plumtree.xpshared.htmlconstructs
Class PTButtonType

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

public class PTButtonType
extends PTConstructType
extends PTConstructType

Author:: BenG The static members of this class provide PTButtonType objects that may be used to obtain constructs from the PTConstructFactory. These constructs describe buttons commonly appearing in the portal ui.

A button is typically a span containing an anchor containing an img and possibly a title. Buttons can also be input elements.

Field Summary
`static PTButtonType`	`ABORT_JOB` Use this PTButtonType to obtain an Abort Job button from the Construct factory
`static PTButtonType`	`ADD_GROUP` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`ADD_ME_ACTIONBAR`
`static PTButtonType`	`ADD_MEMBERS` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`ADD_PORTLET` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`ADD_URL` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`ElementName`	`ANCHOR_ELEMENT_NAME`
`static PTButtonType`	`APPLY_OBJECT_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`APPROVE` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`APPROVE_ALL_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`APPROVE_OBJECT_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`BOTTOM` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`BROWSE` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`BROWSE_HEADER` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`BULK_ADD_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`CLEAR` Use this PTButtonType to obtain a go_up button from the ConstructFactory.
`static PTButtonType`	`CLEAR_DIR_ACTIONBAR` Use this PTButtonType to obtain a go_up button from the ConstructFactory.
`static PTButtonType`	`CLOSE` Use this PTButtonType to obtain a go_up button from the ConstructFactory.
`static PTButtonType`	`COLLAPSE_AREA` Use this PTButtonType to obtain a collapse area button from the ConstructFactory.
`static PTButtonType`	`COLLAPSE_TIPS` Use this PTButtonType to obtain a collapse area button from the ConstructFactory.
`static PTButtonType`	`CONTENT_SNAPSHOT_HEADER`
`static PTButtonType`	`COPY_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`CREATE` Use this PTButtonType to obtain a create button from the ConstructFactory.
`static PTButtonType`	`CREATE_ACCOUNT`
`static PTButtonType`	`CREATE_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`CREATE_CUSTOM_GROUP` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`CREATE_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`CREATE_FOLDER_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`CREATE_OBJ_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`CREATE_PORTLET` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`CREATE_PORTLET_DIR_ACTIONBAR`
`static PTButtonType`	`DELETE` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`DELETE_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`DELETE_OBJ_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`DISABLE_DIR_ACTIONBAR`
`static PTButtonType`	`DOWN` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`EDIT` Use this PTButtonType to obtain an edit button from the ConstructFactory.
`static PTButtonType`	`EDIT_ACTIONBAR` Use this PTButtonType to obtain an edit button from the ConstructFactory.
`static PTButtonType`	`EDIT_DIR_ACTIONBAR` Use this PTButtonType to obtain an edit button from the ConstructFactory.
`static PTButtonType`	`EDIT_FOLDER_DIR_ACTIONBAR` Use this PTButtonType to obtain an edit button from the ConstructFactory.
`static PTButtonType`	`EDIT_HEADER` Use this PTButtonType to obtain an edit button from the ConstructFactory.
`static PTButtonType`	`EDIT_OBJ_ACTIONBAR` Use this PTButtonType to obtain an edit button from the ConstructFactory.
`static java.lang.String`	`ELEMENT_NAME_ID_ANCHOR` Use this constant to obtain the ElementName indicating this button's anchor element.
`static java.lang.String`	`ELEMENT_NAME_ID_IMG` Use this constant to obtain the ElementName indicating this button's img element.
`static java.lang.String`	`ELEMENT_NAME_ID_IMG_2` Use this constant to obtain the ElementName indicating this button's img element.
`static java.lang.String`	`ELEMENT_NAME_ID_TITLE` Use this constant to obtain the ElementName indicating this button's title element.
`static PTButtonType`	`ENABLE_DIR_ACTIONBAR`
`static PTButtonType`	`EXPAND_AREA` Use this PTButtonType to obtain an expand area button from the ConstructFactory.
`static PTButtonType`	`EXPAND_TIPS` Use this PTButtonType to obtain an expand area button from the ConstructFactory.
`static PTButtonType`	`FILTER` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`FINISH` Use this PTButtonType to obtain a finish button from the ConstructFactory.
`static PTButtonType`	`FINISH_DIR_ACTIONBAR`
`static PTButtonType`	`GO_UP` Use this PTButtonType to obtain a go_up button from the ConstructFactory.
`static PTButtonType`	`HELP` Use this PTButtonType to obtain a go_up button from the ConstructFactory.
`static PTButtonType`	`HOLD` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`HOLD_ALL_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`ElementName`	`IMG_2_ELEMENT_NAME`
`ElementName`	`IMG_ELEMENT_NAME`
`static PTButtonType`	`LINK_SETTINGS_OBJECT_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`LOGIN` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`MIGRATE_OBJECTS_DIR_ACTIONBAR`
`static PTButtonType`	`MOVE_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`NEW_BANNER` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`NEW_COMMUNITY_TEMPLATE` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`NEW_FOOTER` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`NEW_PAGE` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`NEW_PAGE_TEMPLATE` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`NEW_SUBCOMMUNITY` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`PREFERENCES_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`PREVIEW` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`REFRESH` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`REFRESH_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`REFRESH_OBJ_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`REJECT` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`REJECT_ALL_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`RENAME_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`RENAME_PAGE` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SEARCH` Use this PTButtonType to obtain a go_up button from the ConstructFactory.
`static PTButtonType`	`SECURITY_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SELECT` Use this PTButtonType to obtain a select button from the ConstructFactory.
`static PTButtonType`	`SELECT_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SELECT_ALL_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SELECT_COMMUNITY_TEMPLATE` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SELECT_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SELECT_LAYOUT` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SELECT_OBJ_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SELECT_PAGE_TEMPLATE` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SEND_TO_OTHERS` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SEND_TO_OTHERS_BANNER_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SORT_DOWN` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SORT_UP` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SUBMIT_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`SUBMIT_HEADER` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`ElementName`	`TITLE_ELEMENT_NAME`
`static PTButtonType`	`TOP` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`UNAPPROVE_OBJECT_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`UNLOCK_OBJ_ACTIONBAR`
`static PTButtonType`	`UNSELECT_ALL_DIR_ACTIONBAR` Use this PTButtonType to obtain a add group button from the ConstructFactory.
`static PTButtonType`	`UP` Use this PTButtonType to obtain a add group button from the ConstructFactory.

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

Method Summary
`static IXPEnumerator`	`GetButtonTypeNames()`
`java.lang.String`	`GetDescription()`
`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 the HTMLElement prototype of this button.
`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 construct.
`static IXPEnumerator`	`GetTypes()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

ELEMENT_NAME_ID_IMG

public static final java.lang.String ELEMENT_NAME_ID_IMG

Use this constant to obtain the ElementName indicating this button's img element.

See Also:: Constant Field Values

ELEMENT_NAME_ID_IMG_2

public static final java.lang.String ELEMENT_NAME_ID_IMG_2

Use this constant to obtain the ElementName indicating this button's img element.

See Also:: Constant Field Values

ELEMENT_NAME_ID_TITLE

public static final java.lang.String ELEMENT_NAME_ID_TITLE

Use this constant to obtain the ElementName indicating this button's title element.

See Also:: Constant Field Values

ELEMENT_NAME_ID_ANCHOR

public static final java.lang.String ELEMENT_NAME_ID_ANCHOR

Use this constant to obtain the ElementName indicating this button's anchor element. Not all button's have anchors, some have inputs, so it's possible that this element name does not indicate a valid html element.

See Also:: Constant Field Values

HELP

public static final PTButtonType HELP

Use this PTButtonType to obtain a go_up button from the ConstructFactory.

SEARCH

public static final PTButtonType SEARCH

Use this PTButtonType to obtain a go_up button from the ConstructFactory.

CLEAR

public static final PTButtonType CLEAR

Use this PTButtonType to obtain a go_up button from the ConstructFactory.

CLEAR_DIR_ACTIONBAR

public static final PTButtonType CLEAR_DIR_ACTIONBAR

Use this PTButtonType to obtain a go_up button from the ConstructFactory.

CLOSE

public static final PTButtonType CLOSE

Use this PTButtonType to obtain a go_up button from the ConstructFactory.

GO_UP

public static final PTButtonType GO_UP

Use this PTButtonType to obtain a go_up button from the ConstructFactory.

COLLAPSE_AREA

public static final PTButtonType COLLAPSE_AREA

Use this PTButtonType to obtain a collapse area button from the ConstructFactory.

COLLAPSE_TIPS

public static final PTButtonType COLLAPSE_TIPS

Use this PTButtonType to obtain a collapse area button from the ConstructFactory.

EXPAND_AREA

public static final PTButtonType EXPAND_AREA

Use this PTButtonType to obtain an expand area button from the ConstructFactory.

EXPAND_TIPS

public static final PTButtonType EXPAND_TIPS

Use this PTButtonType to obtain an expand area button from the ConstructFactory.

FINISH

public static final PTButtonType FINISH

Use this PTButtonType to obtain a finish button from the ConstructFactory.

EDIT

public static final PTButtonType EDIT

Use this PTButtonType to obtain an edit button from the ConstructFactory.

EDIT_ACTIONBAR

public static final PTButtonType EDIT_ACTIONBAR

Use this PTButtonType to obtain an edit button from the ConstructFactory.

ADD_ME_ACTIONBAR

public static final PTButtonType ADD_ME_ACTIONBAR

EDIT_DIR_ACTIONBAR

public static final PTButtonType EDIT_DIR_ACTIONBAR

Use this PTButtonType to obtain an edit button from the ConstructFactory.

EDIT_FOLDER_DIR_ACTIONBAR

public static final PTButtonType EDIT_FOLDER_DIR_ACTIONBAR

Use this PTButtonType to obtain an edit button from the ConstructFactory.

CONTENT_SNAPSHOT_HEADER

public static final PTButtonType CONTENT_SNAPSHOT_HEADER

EDIT_OBJ_ACTIONBAR

public static final PTButtonType EDIT_OBJ_ACTIONBAR

Use this PTButtonType to obtain an edit button from the ConstructFactory.

EDIT_HEADER

public static final PTButtonType EDIT_HEADER

Use this PTButtonType to obtain an edit button from the ConstructFactory.

CREATE

public static final PTButtonType CREATE

Use this PTButtonType to obtain a create button from the ConstructFactory.