Style Intelligence v12.0

inetsoft.sree
Class RepletCommand

java.lang.Object
  extended by inetsoft.sree.RepletCommand
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
RepletCommand.DataBinding, RepletCommand.PromptParameters, RepletCommand.Refresh, RepletCommand.Reprint, RepletCommand.ScrollTo, RepletCommand.SendRequest, RepletCommand.SetChanged, RepletCommand.SetCursor, RepletCommand.ShowDrill, RepletCommand.ShowMenu, RepletCommand.ShowReplet, RepletCommand.ShowReport, RepletCommand.ShowStatus, RepletCommand.ShowURL, RepletCommand.ShowViewsheet

public class RepletCommand
extends Object
implements Serializable

A RepletCommand defines one or more replet actions. It can be used in the EventHandler to add client-side action, or returned from event listeners to specify the action for an event. The actions defined in RepletCommand are executed in the client-side report viewer.

See Also:
Serialized Form

Nested Class Summary
static class RepletCommand.DataBinding
          A command to bind data to element.
static class RepletCommand.PromptParameters
          A command to show a request dialog to prompt for parameter values.
static class RepletCommand.Refresh
          A command to refresh the contents on the viewer.
static class RepletCommand.Reprint
          A command to reprint the contents on the viewer.
static class RepletCommand.ScrollTo
          A command to scroll to a location in a replet.
static class RepletCommand.SendRequest
          A command to send a request to a replet (as a RequestEvent).
static class RepletCommand.SetChanged
          A command to reprint the contents on the viewer.
static class RepletCommand.SetCursor
          A command to change the cursor on the viewer.
static class RepletCommand.ShowDrill
          Command to show a drill.
static class RepletCommand.ShowMenu
          A command to show a popup menu.
static class RepletCommand.ShowReplet
          Command to show a replet.
static class RepletCommand.ShowReport
          Command to show a report.
static class RepletCommand.ShowStatus
          A command to show a message on the status bar of the viewer.
static class RepletCommand.ShowURL
          Command to show a web page.
static class RepletCommand.ShowViewsheet
          Command to show a viewsheet.
 
Constructor Summary
RepletCommand()
          Create an empty command.
 
Method Summary
 RepletCommand addCommand(RepletCommand cmd)
          Add a sub-command to this command.
 RepletCommand addPromptParameters(String reqname)
          Add a command to prompt users for parameters.
 RepletCommand addPromptParameters(String reqname, Dimension size)
          Add a command to prompt users for parameters.
 RepletCommand addRefresh()
          Is a replet issues a refresh() command, its generate() method must handle a call with RepletRequest equals to null.
 RepletCommand addReprint()
          Add a reprint request to format a report again.
 RepletCommand addScrollTo(String eid)
          Add a command to scroll to the element.
 RepletCommand addScrollTo(String eid, int row)
          Add a command to scroll to the element and row.
 RepletCommand addSendRequest(RepletRequest req)
          Add a command to send a request event to the server.
 RepletCommand addSetCursor(int cursor)
          Add a command to change the cursor on viewer.
 RepletCommand addShowMenu(int x, int y, String[] items)
          Add a command to popup a menu at the specified location.
 RepletCommand addShowMenu(int x, int y, String[] items, String[] tips)
          Add a command to popup a menu at the specified location.
 RepletCommand addShowMenu(String[] items)
          Add a command to popup a menu.
 RepletCommand addShowMenu(String[] items, String[] tips)
          Add a command to popup a menu.
 RepletCommand addShowReplet(String name)
          Add a show replet command.
 RepletCommand addShowReplet(String name, RepletRequest param)
          Add a command to show the specified replet on the viewer.
 RepletCommand addShowReplet(String name, RepletRequest param, String frame)
          Add a command to show the specified replet on the viewer.
 RepletCommand addShowReport(String name)
          Add a show report command.
 RepletCommand addShowReport(String name, String frame)
          Add a command to show the specified report on the viewer.
 RepletCommand addShowStatus(String msg)
          Add a command to show status message at status bar.
 RepletCommand addShowURL(String url, String target)
          Add a command to show a web page.
static RepletCommand dataBinding(String elementID, String opFront)
          Launch the data binding editing window.
 boolean equals(Object obj)
           
 RepletCommand getCommand(Class type)
          Get the command that matchs the specified command type.
 RepletCommand getCommand(int n)
          Get the specified command.
 int getCommandCount()
          Get the number of commands in this command.
static RepletCommand promptParameters(String reqname)
          Prompt users for parameters.
static RepletCommand promptParameters(String reqname, Dimension size)
          Prompt users for parameters.
static RepletCommand refresh()
          If a replet issues a refresh() command, its generate() method must handle a call with RepletRequest equals to null.
 void removeCommand(Class type)
          Remove all commands that matchs the specified command type.
static RepletCommand reprint()
          A reprint command causes a report to be printed (formatted) again.
static RepletCommand scrollTo(String eid)
          Scroll to the element.
static RepletCommand scrollTo(String eid, int row)
          Scroll to the element and row.
static RepletCommand sendRequest(RepletRequest req)
          Send a request event to the server.
static RepletCommand setChanged()
          SetChanged command.
static RepletCommand setCursor(int cursor)
          Change the cursor on viewer.
 void setRepletRequest(RepletRequest req)
          Set the request object used for this command.
static RepletCommand showDrill(String name, RepletRequest req, String query, String frame, int linkType)
          Show the specified drill on the viewer.
static RepletCommand showMenu(int x, int y, String[] items)
          Popup a menu at the specified location.
static RepletCommand showMenu(int x, int y, String[] items, String[] tips)
          Popup a menu at the specified location.
static RepletCommand showMenu(String[] items)
          Popup a menu.
static RepletCommand showMenu(String[] items, String[] tips)
          Popup a menu.
static RepletCommand showReplet(String name)
          Show the specified replet on the viewer.
static RepletCommand showReplet(String name, RepletRequest req)
          Show the specified replet on the viewer.
static RepletCommand showReplet(String name, RepletRequest req, String frame)
          Show the specified replet on the viewer.
static RepletCommand showReport(String name)
          Show the specified report on the viewer.
static RepletCommand showReport(String name, String frame)
          Show the specified report on the viewer.
static RepletCommand showReport(String name, String version, String frame)
          Show the specified report on the viewer.
static RepletCommand showStatus(String msg)
          Show status message at status bar.
static RepletCommand showURL(String url, String target)
          Show the Web page referenced by the URL.
static RepletCommand showViewsheet(String name, RepletRequest req, String frame, String title)
          Show the specified viewsheet on the viewer.
static RepletCommand showViewsheet(String name, RepletRequest req, String frame, String title, String bookmarkName, String bookmarkUser)
          Show the specified viewsheet on the viewer.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RepletCommand

public RepletCommand()
Create an empty command.

Method Detail

showReport

public static RepletCommand showReport(String name)
Show the specified report on the viewer.

Parameters:
name - report name.

showReport

public static RepletCommand showReport(String name,
                                       String frame)
Show the specified report on the viewer.

Parameters:
name - report name.
frame - target frame name.

showReport

public static RepletCommand showReport(String name,
                                       String version,
                                       String frame)
Show the specified report on the viewer.

Parameters:
name - report name.
version - report version.
frame - target frame name.

showReplet

public static RepletCommand showReplet(String name)
Show the specified replet on the viewer.

Parameters:
name - replet name.

showReplet

public static RepletCommand showReplet(String name,
                                       RepletRequest req)
Show the specified replet on the viewer.

Parameters:
name - replet name.
req - replet request used to create the replet.

showReplet

public static RepletCommand showReplet(String name,
                                       RepletRequest req,
                                       String frame)
Show the specified replet on the viewer.

Parameters:
name - replet name.
req - replet request used to create the replet.
frame - target frame name.

showViewsheet

public static RepletCommand showViewsheet(String name,
                                          RepletRequest req,
                                          String frame,
                                          String title)
Show the specified viewsheet on the viewer.

Parameters:
name - replet name.
req - replet request used to create the replet.
frame - target frame name.
title - label string.

showViewsheet

public static RepletCommand showViewsheet(String name,
                                          RepletRequest req,
                                          String frame,
                                          String title,
                                          String bookmarkName,
                                          String bookmarkUser)
Show the specified viewsheet on the viewer.

Parameters:
name - replet name.
req - replet request used to create the replet.
frame - target frame name.
title - label string.

showDrill

public static RepletCommand showDrill(String name,
                                      RepletRequest req,
                                      String query,
                                      String frame,
                                      int linkType)
Show the specified drill on the viewer.

Parameters:
name - replet name.
req - replet request used to create the replet.
frame - target frame name.

dataBinding

public static RepletCommand dataBinding(String elementID,
                                        String opFront)
Launch the data binding editing window.


showURL

public static RepletCommand showURL(String url,
                                    String target)
Show the Web page referenced by the URL. If the target is null, it replaces the current frame with the document.

Parameters:
url - URL string.
target - target frame to display the document.

showMenu

public static RepletCommand showMenu(String[] items)
Popup a menu.

Parameters:
items - popup menu items.

showMenu

public static RepletCommand showMenu(String[] items,
                                     String[] tips)
Popup a menu.

Parameters:
items - popup menu items.
tips - menu items tooltip texts.

showMenu

public static RepletCommand showMenu(int x,
                                     int y,
                                     String[] items)
Popup a menu at the specified location.

Parameters:
x - x coord.
y - y coord.
items - menu items.

showMenu

public static RepletCommand showMenu(int x,
                                     int y,
                                     String[] items,
                                     String[] tips)
Popup a menu at the specified location.

Parameters:
x - x coord.
y - y coord.
items - menu items.
tips - menu items tooltip texts.

setCursor

public static RepletCommand setCursor(int cursor)
Change the cursor on viewer. This command may be ignored by browsers.

Parameters:
cursor - predefined cursor style.

promptParameters

public static RepletCommand promptParameters(String reqname)
Prompt users for parameters.

Parameters:
reqname - name of the request to prompt for.

promptParameters

public static RepletCommand promptParameters(String reqname,
                                             Dimension size)
Prompt users for parameters.

Parameters:
reqname - name of the request to prompt for.
size - the parameter window size.

sendRequest

public static RepletCommand sendRequest(RepletRequest req)
Send a request event to the server.

Parameters:
req - replet request.

refresh

public static RepletCommand refresh()
If a replet issues a refresh() command, its generate() method must handle a call with RepletRequest equals to null. This signals a request to refresh the report.


reprint

public static RepletCommand reprint()
A reprint command causes a report to be printed (formatted) again. The existing data is intact and no new query is issued.


setChanged

public static RepletCommand setChanged()
SetChanged command.


scrollTo

public static RepletCommand scrollTo(String eid)
Scroll to the element.

Parameters:
eid - element ID.

scrollTo

public static RepletCommand scrollTo(String eid,
                                     int row)
Scroll to the element and row.

Parameters:
eid - element ID.
row - row number.

showStatus

public static RepletCommand showStatus(String msg)
Show status message at status bar.

Parameters:
msg - status message.

setRepletRequest

public void setRepletRequest(RepletRequest req)
Set the request object used for this command. It is only used by some command and ignored by others. This method is called when a command is launched by a RequestEvent. The request object in the request event is passed to the commands before the commands are executed.

Parameters:
req - replet request object.

getCommandCount

public int getCommandCount()
Get the number of commands in this command.


getCommand

public RepletCommand getCommand(int n)
Get the specified command.

Parameters:
n - command index.

getCommand

public RepletCommand getCommand(Class type)
Get the command that matchs the specified command type.

Parameters:
type - type of the command to look for.

removeCommand

public void removeCommand(Class type)
Remove all commands that matchs the specified command type.

Parameters:
type - type of the command to remove;

addCommand

public RepletCommand addCommand(RepletCommand cmd)
Add a sub-command to this command.

Parameters:
cmd - sub-command.

addShowReplet

public RepletCommand addShowReplet(String name)
Add a show replet command.

Parameters:
name - replet name.

addShowReplet

public RepletCommand addShowReplet(String name,
                                   RepletRequest param)
Add a command to show the specified replet on the viewer.

Parameters:
name - replet name.
param - replet request used to create the replet.

addShowReplet

public RepletCommand addShowReplet(String name,
                                   RepletRequest param,
                                   String frame)
Add a command to show the specified replet on the viewer.

Parameters:
name - replet name.
param - replet request used to create the replet.
frame - target frame name.

addShowReport

public RepletCommand addShowReport(String name)
Add a show report command.

Parameters:
name - replet name.

addShowReport

public RepletCommand addShowReport(String name,
                                   String frame)
Add a command to show the specified report on the viewer.

Parameters:
name - report name.
frame - target frame name.

addShowURL

public RepletCommand addShowURL(String url,
                                String target)
Add a command to show a web page.

Parameters:
url - URL string.
target - target frame name or null for current frame.

addShowMenu

public RepletCommand addShowMenu(String[] items)
Add a command to popup a menu.

Parameters:
items - popup menu items.

addShowMenu

public RepletCommand addShowMenu(String[] items,
                                 String[] tips)
Add a command to popup a menu.

Parameters:
items - popup menu items.
tips - menu items tooltip texts.

addShowMenu

public RepletCommand addShowMenu(int x,
                                 int y,
                                 String[] items)
Add a command to popup a menu at the specified location.

Parameters:
x - x coord.
y - y coord.
items - menu items.

addShowMenu

public RepletCommand addShowMenu(int x,
                                 int y,
                                 String[] items,
                                 String[] tips)
Add a command to popup a menu at the specified location.

Parameters:
x - x coord.
y - y coord.
items - menu items.
tips - menu items tooltip texts.

addSetCursor

public RepletCommand addSetCursor(int cursor)
Add a command to change the cursor on viewer. This command may be ignored by browsers.

Parameters:
cursor - predefined cursor style.

addPromptParameters

public RepletCommand addPromptParameters(String reqname)
Add a command to prompt users for parameters.

Parameters:
reqname - name of the request to prompt for.

addPromptParameters

public RepletCommand addPromptParameters(String reqname,
                                         Dimension size)
Add a command to prompt users for parameters.

Parameters:
reqname - name of the request to prompt for.
size - parameter window size.

addSendRequest

public RepletCommand addSendRequest(RepletRequest req)
Add a command to send a request event to the server.

Parameters:
req - replet request.

addRefresh

public RepletCommand addRefresh()
Is a replet issues a refresh() command, its generate() method must handle a call with RepletRequest equals to null. This signals a request to refresh the report.


addReprint

public RepletCommand addReprint()
Add a reprint request to format a report again.


addScrollTo

public RepletCommand addScrollTo(String eid)
Add a command to scroll to the element.

Parameters:
eid - element ID.

addScrollTo

public RepletCommand addScrollTo(String eid,
                                 int row)
Add a command to scroll to the element and row.

Parameters:
eid - element ID.
row - row number.

addShowStatus

public RepletCommand addShowStatus(String msg)
Add a command to show status message at status bar.

Parameters:
msg - status message.

toString

public String toString()
Overrides:
toString in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.