com.filenet.wcm.toolkit.server.util
Class WcmHelpMap

java.lang.Object
  extended byjava.util.Dictionary
      extended byjava.util.Hashtable
          extended byjava.util.Properties
              extended bycom.filenet.wcm.toolkit.server.util.WcmHelpMap
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map, java.io.Serializable

public class WcmHelpMap
extends java.util.Properties

WcmHelpMap serves up a map of key/values that map internal help file names to their equivalent actual help file names.

See Also:
Serialized Form

Field Summary
protected static java.lang.String HELP_DEFAULT_PATH
           
static java.lang.String HELP_EXTENSION_KEY
           
static java.lang.String HELP_ROOT_PATH_KEY
           
protected  java.lang.String helpExtension
           
 
Fields inherited from class java.util.Properties
defaults
 
Constructor Summary
WcmHelpMap(java.io.InputStream in)
           
WcmHelpMap(java.lang.String basePath)
          Deprecated. use WcmHelpMap(InputStream in)
 
Method Summary
 java.lang.Object get(java.lang.Object key)
          Get the value for the specified key.
 java.lang.String getHelpRootPath()
          Get the help root path by looking up the key HELP_PATH_ROOT_KEY in the help map.
 java.lang.String getQualifiedHelpURL(java.lang.String helpKey, java.lang.String helpBaseURL)
          Get the full qualified URL to the context sensitive help HTML based on the help map.
 java.lang.String getQualifiedHelpURL(java.lang.String helpKey, java.lang.String helpBaseURL, java.lang.String extension)
          Get the full qualified URL to the context sensitive help HTML based on the help map.
static WcmHelpMap getWcmHelpMap(javax.servlet.ServletContext sc)
           
 
Methods inherited from class java.util.Properties
getProperty, getProperty, list, list, load, propertyNames, save, setProperty, store
 
Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

HELP_ROOT_PATH_KEY

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

HELP_EXTENSION_KEY

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

HELP_DEFAULT_PATH

protected static final java.lang.String HELP_DEFAULT_PATH
See Also:
Constant Field Values

helpExtension

protected java.lang.String helpExtension
Constructor Detail

WcmHelpMap

public WcmHelpMap(java.lang.String basePath)
Deprecated. use WcmHelpMap(InputStream in)


WcmHelpMap

public WcmHelpMap(java.io.InputStream in)
Method Detail

getWcmHelpMap

public static WcmHelpMap getWcmHelpMap(javax.servlet.ServletContext sc)

get

public java.lang.Object get(java.lang.Object key)
Get the value for the specified key. If a value does not exist for the key, the key itself is returned.

Parameters:
key -
Returns:
The value, or the key if no value exists.

getHelpRootPath

public java.lang.String getHelpRootPath()
Get the help root path by looking up the key HELP_PATH_ROOT_KEY in the help map. If not defined the default value "help" is returned.

Returns:
The help root path.

getQualifiedHelpURL

public java.lang.String getQualifiedHelpURL(java.lang.String helpKey,
                                            java.lang.String helpBaseURL,
                                            java.lang.String extension)
Get the full qualified URL to the context sensitive help HTML based on the help map. The value in the help map may contain "#anchor" notation. If present, the extension is inserted in front of it before calculating the final URL.

Parameters:
helpKey - - The help key produced by the controller.
helpBaseURL - - The base url where help is located ex: "http://host:port/app"
extension - - The extension. If null, the default extension of "htm" is used unless htmlExtension is defined in the help map.
Returns:
The help URL.

getQualifiedHelpURL

public java.lang.String getQualifiedHelpURL(java.lang.String helpKey,
                                            java.lang.String helpBaseURL)
Get the full qualified URL to the context sensitive help HTML based on the help map. The default extension of "htm" is used unless htmlExtension is defined in the help map. The value in the help map may contain "#anchor" notation. If present, the extension is inserted in front of it before calculating the final URL.

Parameters:
helpKey - - The help key produced by the controller.
helpBaseURL - - The base url where help is located ex: "http://host:port/app"
Returns:
The help URL.


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