java.lang.Object

wt.help.HelpLinkHelper

public class HelpLinkHelper extends Object

This class is used in conjunction with application context to lookup a given help resource from a provided selector.

Supported API: true

Extendable: false

See Also:

WTServiceProviderFromProperties

Method Summary

Modifier and Type

Method

Description

static String

createHelpHREF(wt.help.HelpLinkContext helpContext, Locale locale, HashMap props)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, Object context, String selector, Locale locale)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, Object context, String selector, Locale locale, HashMap props)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, Object context, String selector, Locale locale, HashMap props, HelpLinkHelper helper)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, Object context, String selector, Locale locale, HelpLinkHelper helper)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, String service_name, Object context, String selector, Locale locale)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, String service_name, Object context, String selector, Locale locale, HashMap props)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, String service_name, Object context, String selector, Locale locale, HashMap props, HelpLinkHelper helper)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, String service_name, Object context, String selector, Locale locale, HelpLinkHelper helper)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, String selector, HashMap props)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, String selector, Locale locale)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, String selector, Locale locale, HashMap props)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, String selector, Locale locale, HashMap props, HelpLinkHelper helper)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

static String

createHelpHREF(URLFactory factory, String selector, Locale locale, HelpLinkHelper helper)

Deprecated.
Use createHelpHREF(java.lang.String) instead.

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

Method Details
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, String service_name, Object context, String selector, Locale locale, HashMap props) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  service_name - Ignored. An error is logged if this does not match SERVICE_NAME.
  
  context - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  props - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(wt.help.HelpLinkContext helpContext, Locale locale, HashMap props) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the selector provided in the HelpLinkContext.
  Supported API: true
  
  Parameters:
  
  helpContext - The help context object provides the selector used in looking up the help resource.
  
  locale - Ignored.
  
  props - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, String service_name, Object context, String selector, Locale locale) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  service_name - Ignored. An error is logged if this does not match SERVICE_NAME.
  
  context - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, String service_name, Object context, String selector, Locale locale, HelpLinkHelper helper) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  service_name - Ignored. An error is logged if this does not match SERVICE_NAME.
  
  context - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  helper - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, Object context, String selector, Locale locale, HashMap props) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  context - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  props - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, Object context, String selector, Locale locale, HashMap props, HelpLinkHelper helper) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  context - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  props - Ignored.
  
  helper - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, Object context, String selector, Locale locale) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  context - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, Object context, String selector, Locale locale, HelpLinkHelper helper) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  context - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  helper - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, String selector, Locale locale, HashMap props) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  props - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, String selector, Locale locale) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, String selector, Locale locale, HelpLinkHelper helper) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  helper - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, String service_name, Object context, String selector, Locale locale, HashMap props, HelpLinkHelper helper) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  service_name - Ignored. An error is logged if this does not match SERVICE_NAME.
  
  context - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  props - Ignored.
  
  helper - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, String selector, Locale locale, HashMap props, HelpLinkHelper helper) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  selector - The selector for the desired help resource
  
  locale - Ignored.
  
  props - Ignored.
  
  helper - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved
- createHelpHREF
  
  @Deprecated public static String createHelpHREF(URLFactory factory, String selector, HashMap props) throws Exception
  
  Deprecated.
  Use createHelpHREF(java.lang.String) instead.
  
  This method will lookup the help resource given the provided selector.
  Supported API: true
  
  Parameters:
  
  factory - Ignored.
  
  selector - The selector for the desired help resource
  
  props - Ignored.
  
  Returns:
  
  The help resource HREF.
  
  Throws:
  
  Exception - if the WHC url can not be retrieved

Class HelpLinkHelper

Method Summary

Methods inherited from class java.lang.Object

Method Details

createHelpHREF

createHelpHREF

createHelpHREF

createHelpHREF

createHelpHREF

createHelpHREF

createHelpHREF

createHelpHREF

createHelpHREF

createHelpHREF

createHelpHREF

createHelpHREF

createHelpHREF

createHelpHREF