org.apache.myfaces.trinidadinternal.el
Class SecondaryWindowHelpProvider

java.lang.Object
  extended by org.apache.myfaces.trinidadinternal.el.HelpProvider
      extended by org.apache.myfaces.trinidadinternal.el.SecondaryWindowHelpProvider
Direct Known Subclasses:
OracleHelpProvider

public abstract class SecondaryWindowHelpProvider
extends HelpProvider

Most HelpProvider implementations will wish to return a javascript pseudo URL that will launch a secondary window for displaying help topics and help system pages on user agents that support JavaScript.

This functionality is provided in the SecondaryWindowHelpProvider abstract class. Classes that extend SecondaryWindowHelpProvider need only provide an implementation for the getHelpTopicURL() and getHelpSystemURL() method. SecondaryWindowHelpProvider will wrap the returned value in a javascript pseudo URL if the user agent supports javascript, and will return the string URL directly if the user agent does not.

Version:
$Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/el/SecondaryWindowHelpProvider.java#0 $) $Date: 10-nov-2005.19:06:19 $
Author:
The Oracle ADF Faces Team

Field Summary
static int DEFAULT_WINDOW_HEIGHT
           
static int DEFAULT_WINDOW_WIDTH
           
 
Fields inherited from class org.apache.myfaces.trinidadinternal.el.HelpProvider
FRONT_PAGE_KEY
 
Constructor Summary
SecondaryWindowHelpProvider()
           
 
Method Summary
protected abstract  java.lang.String getHelpSystemURL(java.lang.Object key)
          The getHelpSystemURL() method should return a string URL for the given key string (HelpProvider System Key)
 java.lang.Object getHelpSystemValue(java.lang.Object key)
          The SecondaryWindowHelpProvider implementation of getHelpSystemValue() wraps the value returned by getHelpSystemURL() with javascript code to launch a secondary window (if the user agent supports javascript).
protected abstract  java.lang.String getHelpTopicURL(java.lang.Object key)
          The getHelpTopicURL() method should return a string URL for the given key string (topic-id).
 java.lang.Object getHelpTopicValue(java.lang.Object key)
          The SecondaryWindowHelpProvider implementation of getHelpTopicValue() wraps the value returned by getHelpTopicURL() with javascript code to launch a secondary window (if the user agent supports javascript).
 int getWindowHeight()
          Returns the requested height of the secondary window
 int getWindowWidth()
          Returns the requested width of the secondary window
protected  boolean isJavascriptSupported()
           
 void setWindowHeight(int windowHeight)
          Set the requested height of the secondary window
 void setWindowWidth(int windowWidth)
          Set the requested width of the secondary window
 
Methods inherited from class org.apache.myfaces.trinidadinternal.el.HelpProvider
getHelpSystemMap, getHelpTopicMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_WINDOW_WIDTH

public static final int DEFAULT_WINDOW_WIDTH
See Also:
Constant Field Values

DEFAULT_WINDOW_HEIGHT

public static final int DEFAULT_WINDOW_HEIGHT
See Also:
Constant Field Values
Constructor Detail

SecondaryWindowHelpProvider

public SecondaryWindowHelpProvider()
Method Detail

getHelpTopicValue

public java.lang.Object getHelpTopicValue(java.lang.Object key)
The SecondaryWindowHelpProvider implementation of getHelpTopicValue() wraps the value returned by getHelpTopicURL() with javascript code to launch a secondary window (if the user agent supports javascript).

Specified by:
getHelpTopicValue in class HelpProvider
Parameters:
key - criterion (topic-id)
Returns:
the value (should be string destination) for the selection criteria

getHelpSystemValue

public java.lang.Object getHelpSystemValue(java.lang.Object key)
The SecondaryWindowHelpProvider implementation of getHelpSystemValue() wraps the value returned by getHelpSystemURL() with javascript code to launch a secondary window (if the user agent supports javascript).

Specified by:
getHelpSystemValue in class HelpProvider
Parameters:
key - criterion (HelpProvider key constant)
Returns:
the value (should be string destination) for the selection criteria

getWindowHeight

public int getWindowHeight()
Returns the requested height of the secondary window


setWindowHeight

public void setWindowHeight(int windowHeight)
Set the requested height of the secondary window

Parameters:
windowHeight - the new requested height

getWindowWidth

public int getWindowWidth()
Returns the requested width of the secondary window


setWindowWidth

public void setWindowWidth(int windowWidth)
Set the requested width of the secondary window

Parameters:
windowWidth - the new requested height

getHelpTopicURL

protected abstract java.lang.String getHelpTopicURL(java.lang.Object key)
The getHelpTopicURL() method should return a string URL for the given key string (topic-id).

Parameters:
key - criterion (topic-id)

getHelpSystemURL

protected abstract java.lang.String getHelpSystemURL(java.lang.Object key)
The getHelpSystemURL() method should return a string URL for the given key string (HelpProvider System Key)

Parameters:
key - criterion (HelpProvider System Key)

isJavascriptSupported

protected boolean isJavascriptSupported()


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.