oracle.cabo.ui.data.help
Class SecondaryWindowHelpProvider
java.lang.Object
|
+--oracle.cabo.ui.data.help.HelpProvider
|
+--oracle.cabo.ui.data.help.SecondaryWindowHelpProvider
- All Implemented Interfaces:
- DataProvider
- 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.
- See Also:
Method Summary |
protected abstract java.lang.String |
getHelpSystemURL(RenderingContext context, java.lang.Object select)
The getHelpSystemURL() method should return a string URL for the given select string (HelpProvider System Key) |
protected abstract java.lang.String |
getHelpTopicURL(RenderingContext context, java.lang.Object select)
The getHelpTopicURL() method should return a string URL for the given select string (topic-id). |
int |
getWindowHeight()
Returns the requested height of the secondary window |
int |
getWindowWidth()
Returns the requested width of the secondary window |
java.lang.Object |
selectHelpSystemValue(RenderingContext context, java.lang.Object select)
The SecondaryWindowHelpProvider implementation of selectHelpSystemValue() wraps the value returned by getHelpSystemURL() with javascript code to launch a secondary window (if the user agent supports javascript). |
java.lang.Object |
selectHelpTopicsValue(RenderingContext context, java.lang.Object select)
The SecondaryWindowHelpProvider implementation of selectHelpTopicsValue() wraps the value returned by getHelpTopicURL() with javascript code to launch a secondary window (if the user agent supports javascript). |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DEFAULT_WINDOW_WIDTH
public static final int DEFAULT_WINDOW_WIDTH
DEFAULT_WINDOW_HEIGHT
public static final int DEFAULT_WINDOW_HEIGHT
SecondaryWindowHelpProvider
public SecondaryWindowHelpProvider()
selectHelpTopicsValue
public java.lang.Object selectHelpTopicsValue(RenderingContext context,
java.lang.Object select)
- The SecondaryWindowHelpProvider implementation of selectHelpTopicsValue() wraps the value returned by getHelpTopicURL() with javascript code to launch a secondary window (if the user agent supports javascript).
-
- Overrides:
selectHelpTopicsValue
in class HelpProvider
-
- Parameters:
context
- the current rendering context
select
- criterion (topic-id)
selectHelpSystemValue
public java.lang.Object selectHelpSystemValue(RenderingContext context,
java.lang.Object select)
- The SecondaryWindowHelpProvider implementation of selectHelpSystemValue() wraps the value returned by getHelpSystemURL() with javascript code to launch a secondary window (if the user agent supports javascript).
-
- Overrides:
selectHelpSystemValue
in class HelpProvider
-
- Parameters:
context
- the current rendering context
select
- criterion (HelpProvider key constant)
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(RenderingContext context,
java.lang.Object select)
- The getHelpTopicURL() method should return a string URL for the given select string (topic-id).
-
- Parameters:
context
- the current rendering context
select
- criterion (topic-id)
getHelpSystemURL
protected abstract java.lang.String getHelpSystemURL(RenderingContext context,
java.lang.Object select)
- The getHelpSystemURL() method should return a string URL for the given select string (HelpProvider System Key)
-
- Parameters:
context
- the current rendering context
select
- criterion (HelpProvider System Key)