com.filenet.wcm.apps.server.presentation.util
Class PulldownLink

java.lang.Object
  extended bycom.filenet.wcm.apps.server.presentation.util.PulldownLink

public class PulldownLink
extends java.lang.Object

PulldownLink provides static methods to support creation of pulldown link "hover" labels as presented in Workplace. This is typically a localized String label with a caret image to the right of it pointing downward. The caret indicates that clicking on the label will show a JavaScript based pulldown UI, such as a menu or folder tree/path selector.


Field Summary
static java.lang.String hoverImage
           
static java.lang.String image
           
protected static java.lang.String imgElementFormat
           
static java.lang.String linkClassName
           
protected static java.lang.String linkFormat
           
protected static java.lang.String linkPathHandlerFormat
           
 
Method Summary
static java.lang.String getHTML(java.util.Locale locale, com.filenet.wcm.toolkit.util.WcmString formatString, java.lang.String anchorElementName, java.lang.String imageElementName, java.lang.String onClick, java.lang.String onContextMenu)
          Get PulldownLink HTML.
static java.lang.String getHTML(java.lang.String formatString, java.lang.String pathHandler, java.lang.String imageElementName)
          Get PulldownLink HTML.
static java.lang.String getHTML(java.lang.String formatString, java.lang.String pathLabel, java.lang.String pathHandler, java.lang.String imageElementName)
          Deprecated. use getHTML(WcmString formatString, String pathLabel, String pathHandler, String imageElementName, Locale locale) Get PulldownLink HTML. This signature is provided to support the notion of a path handler String as defined by TreeModule.
static java.lang.String getHTML(java.lang.String formatString, java.lang.String anchorElementName, java.lang.String className, java.lang.String imageElementName, java.lang.String onClick, java.lang.String onContextMenu)
          Get PulldownLink HTML.
static java.lang.String getHTML(com.filenet.wcm.toolkit.util.WcmString formatString, java.lang.String pathLabel, java.lang.String pathHandler, java.lang.String imageElementName, java.util.Locale locale)
          Get PulldownLink HTML.
static void includeHeaders(com.filenet.wcm.toolkit.server.base.WcmController controller)
          Include JavaScript that preloads the "hover" image.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

image

public static final java.lang.String image
See Also:
Constant Field Values

hoverImage

public static final java.lang.String hoverImage
See Also:
Constant Field Values

linkClassName

public static final java.lang.String linkClassName
See Also:
Constant Field Values

imgElementFormat

protected static final java.lang.String imgElementFormat

linkFormat

protected static final java.lang.String linkFormat

linkPathHandlerFormat

protected static final java.lang.String linkPathHandlerFormat
Method Detail

getHTML

public static java.lang.String getHTML(java.util.Locale locale,
                                       com.filenet.wcm.toolkit.util.WcmString formatString,
                                       java.lang.String anchorElementName,
                                       java.lang.String imageElementName,
                                       java.lang.String onClick,
                                       java.lang.String onContextMenu)
Get PulldownLink HTML.

Parameters:
formatString - Label format including {0} for the location where the caret should go.
anchorElementName - Name for the anchor element.
imageElementName - Name for the image element to support rollover highlighting JavaScript.
onClick - JavaScript to execute for the onClick event.
onContextMenu - JavaScript to execute for the onContextMenu event.
Returns:
The HTML for the pulldown link.

getHTML

public static java.lang.String getHTML(java.lang.String formatString,
                                       java.lang.String anchorElementName,
                                       java.lang.String className,
                                       java.lang.String imageElementName,
                                       java.lang.String onClick,
                                       java.lang.String onContextMenu)
Get PulldownLink HTML.

Parameters:
formatString - Label format including {0} for the location where the caret should go.
anchorElementName - Name for the anchor element.
imageElementName - Name for the image element to support rollover highlighting JavaScript.
onClick - JavaScript to execute for the onClick event.
onContextMenu - JavaScript to execute for the onContextMenu event.
Returns:
The HTML for the pulldown link.

getHTML

public static java.lang.String getHTML(java.lang.String formatString,
                                       java.lang.String pathHandler,
                                       java.lang.String imageElementName)
Get PulldownLink HTML. This signature is provided to support the notion of a path handler String as defined by TreeModule.

Parameters:
formatString - Label format including {0} for the location where the caret should go.
pathHandler - The path handler String as retreived from TreeModule.
imageElementName - Name for the image element to support rollover highlighting JavaScript.
Returns:
The HTML for the pulldown link.

getHTML

public static java.lang.String getHTML(com.filenet.wcm.toolkit.util.WcmString formatString,
                                       java.lang.String pathLabel,
                                       java.lang.String pathHandler,
                                       java.lang.String imageElementName,
                                       java.util.Locale locale)
Get PulldownLink HTML. This signature is provided to support the notion of a path handler String as defined by TreeModule.

Parameters:
formatString - Label format including {0} {1} for the location where the localized label and caret should go.
pathHandler - The path handler String as retreived from TreeModule.
pathLabel - The path label.
imageElementName - Name for the image element to support rollover highlighting JavaScript.
Returns:
The HTML for the pulldown link.

getHTML

public static java.lang.String getHTML(java.lang.String formatString,
                                       java.lang.String pathLabel,
                                       java.lang.String pathHandler,
                                       java.lang.String imageElementName)
Deprecated. use getHTML(WcmString formatString, String pathLabel, String pathHandler, String imageElementName, Locale locale) Get PulldownLink HTML. This signature is provided to support the notion of a path handler String as defined by TreeModule.

Parameters:
formatString - Label format including {0} {1} for the location where the localized label and caret should go.
pathHandler - The path handler String as retreived from TreeModule.
pathLabel - The path label.
imageElementName - Name for the image element to support rollover highlighting JavaScript.
Returns:
The HTML for the pulldown link.

includeHeaders

public static void includeHeaders(com.filenet.wcm.toolkit.server.base.WcmController controller)
Include JavaScript that preloads the "hover" image. Not required, just nice to have.

Parameters:
controller -


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.