|
SilverStream Application Server 3.5 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sssw.rt.form.PvHelperBrowser
The PvHelperBrowser class provides methods to manage the user's browser. An instance of the PvHelperBrowser, called agBrowser, is supplied with every instance of a form.
Note: Including forms or views in pages is not supported in SilverStream 3.0 due to limitations of the Sun Java 1.2 browser plug-in. We hope to re-enable this support in SilverStream in the future. See the release notes for updated information.
Constructor Summary | |
PvHelperBrowser()
|
Method Summary | |
Applet |
getApplet()
Get the applet containing the form |
AppletContext |
getAppletContext()
Returns the applet context for the SilverStream form. |
boolean |
playSound(String soundSpec)
Play a sound |
boolean |
showPage(String pagespec)
Move the current frame of the browser to a new page |
boolean |
showPage(String pagespec,
String frame)
Move the browser to a new page in the specified frame. |
boolean |
showPage(String pagespec,
String frame,
Hashtable params)
Moves the browser to a new page in the specified frame. |
boolean |
showPage(String pagespec,
String frame,
String query,
String orderby,
Hashtable params)
Move the browser to a new page in the specified frame. |
void |
showStatus(String message)
Show a status message in the browser's status bar |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public PvHelperBrowser()
Method Detail |
public boolean showPage(String pagespec)
pagespec
- a page-spec for the page. This can be:
boolean successful; successful = agBrowser.showPage("index.html");
public boolean showPage(String pagespec, String frame)
pagespec
- a page-spec for the page. This can be:
frame
- The name of the browser frame to switch to the new page.
A null value is interpreted as "_self," the current
frame.boolean successful; successful = agBrowser.showPage("index.html", "right");
public boolean showPage(String pagespec, String frame, Hashtable params)
pagespec
- the page to show. This can be:
frame
- the name of the browser frame to switch to the new page.
A null value is interpreted as "_self," the current frame.params
- a hashtable containing parameters to pass to all
presentations on the specified page.Hashtable params; params = new Hashtable(); // add useful data to hashtable here boolean successful; successful = agBrowser.showPage("index.html", "right", params);
public boolean showPage(String pagespec, String frame, String query, String orderby, Hashtable params)
pagespec
- a page-spec for the page. This can be:
frame
- the name of the browser frame to switch to the new page.
A null value is interpreted as "_self," the current
frame.query
- a query to subset the records displayed on the pageorderby
- an orderby clause for the records on the pageparams
- a hashtable containing parameters to pass to all
presentations on the specified pageThe query is appended (using the AND operator) to any existing queries (Where clauses) on all of the forms that reside on the page. If the target forms contains a call to the query() method, then the query() method overrides any query string passed to the form or page.
Hashtable params; params = new Hashtable(); // add useful data to hashtable here boolean successful; successful = agBrowser.showPage("Employees.html", "right", "Employees.salary > 35000", "Employees.lastname asc", params);
public void showStatus(String message)
message
- the message to displayagBrowser.showStatus(numRecords + " records retrieved");
public boolean playSound(String soundSpec)
soundSpec
- the sound to playThe soundSpec can be one of the following:
boolean successful; successful = agBrowser.playSound("ding.au");
public Applet getApplet()
public AppletContext getAppletContext()
The java.applet.AppletContext is an interface that corresponds to an applet's current environment. Forms running in SilverJRunner do not have an AppletContext.
java.applet.AppletContext appletContext; appletContext = agBrowser.getAppletContext();
|
SilverStream Application Server 3.5 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |