com.filenet.wcm.toolkit.server.util

Class WcmHelpMap

  1. java.lang.Object
  2. extended byjava.util.Dictionary<K,V>
  3. extended byjava.util.Hashtable<java.lang.Object,java.lang.Object>
  4. extended byjava.util.Properties
  5. extended bycom.filenet.wcm.toolkit.server.util.WcmHelpMap
All implemented interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>
  1. public class WcmHelpMap
  2. 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

Modifier and Type Field and Description
  1. protected static
  2. java.lang.String
 HELP_DEFAULT_PATH
  1. static
  2. java.lang.String
 HELP_EXTENSION_KEY
  1. static
  2. java.lang.String
 HELP_ROOT_PATH_KEY
  1. protected
  2. java.lang.String
 helpExtension
Fields inherited from class java.util.Properties
defaults

Constructor Summary

Constructor and Description
WcmHelpMap(java.io.InputStream in)
WcmHelpMap(java.lang.String basePath)
Deprecated. use WcmHelpMap(InputStream in)

Method Summary

Modifier and Type Method and Description
  1. java.lang.Object
 get(java.lang.Object key)
Get the value for the specified key.
  1. java.lang.String
 getHelpRootPath()
Get the help root path by looking up the key HELP_PATH_ROOT_KEY in the help map.
  1. 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.
  1. 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.
  1. static
  2. WcmHelpMap
 getWcmHelpMap(javax.servlet.ServletContext sc)
Methods inherited from class java.util.Properties
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames
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

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

HELP_EXTENSION_KEY

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

HELP_DEFAULT_PATH

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

helpExtension

  1. protected java.lang.String helpExtension

Constructor Detail

WcmHelpMap

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

WcmHelpMap

  1. public WcmHelpMap(java.io.InputStream in)

Method Detail

getWcmHelpMap

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

get

  1. 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.
Specified by:
get in interface java.util.Map<java.lang.Object,java.lang.Object>
Overrides:
get in class java.util.Hashtable<java.lang.Object,java.lang.Object>
Parameters:
key -
Returns:
The value, or the key if no value exists.

getHelpRootPath

  1. 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

  1. public java.lang.String getQualifiedHelpURL( java.lang.String helpKey,
  2. java.lang.String helpBaseURL,
  3. 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

  1. public java.lang.String getQualifiedHelpURL( java.lang.String helpKey,
  2. 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.