|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.trinidadinternal.el.HelpProvider
org.apache.myfaces.trinidadinternal.el.SecondaryWindowHelpProvider
public abstract class SecondaryWindowHelpProvider
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.
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 |
---|
public static final int DEFAULT_WINDOW_WIDTH
public static final int DEFAULT_WINDOW_HEIGHT
Constructor Detail |
---|
public SecondaryWindowHelpProvider()
Method Detail |
---|
public java.lang.Object getHelpTopicValue(java.lang.Object key)
getHelpTopicValue
in class HelpProvider
key
- criterion (topic-id)
public java.lang.Object getHelpSystemValue(java.lang.Object key)
getHelpSystemValue
in class HelpProvider
key
- criterion (HelpProvider key constant)
public int getWindowHeight()
public void setWindowHeight(int windowHeight)
windowHeight
- the new requested heightpublic int getWindowWidth()
public void setWindowWidth(int windowWidth)
windowWidth
- the new requested heightprotected abstract java.lang.String getHelpTopicURL(java.lang.Object key)
key
- criterion (topic-id)protected abstract java.lang.String getHelpSystemURL(java.lang.Object key)
key
- criterion (HelpProvider System Key)protected boolean isJavascriptSupported()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |