|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.sree.RepletParameters
public class RepletParameters
This is a parameter description class. It describes the parameters of a report, including name, type, and default values. A replet can declare its parameters by creating a RepletParameters object, specify the parameters, and register it by calling BasicReplet.addRepletParameters().
A parameter declaration also includes the request type. It can be one of the request types defined in RepletRequest.
| Nested Class Summary | |
|---|---|
static class |
RepletParameters.BooleanParameter
Boolean parameter. |
static class |
RepletParameters.ChoiceParameter
Choice parameter. |
static class |
RepletParameters.DateParameter
Date parameter. |
static class |
RepletParameters.DateTimeParameter
DateTime parameter. |
static class |
RepletParameters.ListParameter
List parameter. |
static class |
RepletParameters.OptionParameter
Option group parameter. |
static class |
RepletParameters.Parameter
Parameter base class. |
static class |
RepletParameters.PasswordParameter
Password parameters. |
static class |
RepletParameters.RadioParameter
Radio group parameter. |
static class |
RepletParameters.SimpleParameter
Simple parameter class. |
static class |
RepletParameters.TextAreaParameter
TextArea parameter. |
static class |
RepletParameters.TimeParameter
Time parameter. |
| Constructor Summary | |
|---|---|
RepletParameters(String name)
Create a replet parameters object. |
|
| Method Summary | |
|---|---|
RepletParameters.Parameter |
addBoolean(String name,
boolean def)
Add a boolean value (represented as a checkbox in request dialog). |
RepletParameters.Parameter |
addChoice(String name,
Object def,
Object[] items)
Add a choice (represented as a combobox in request dialog). |
RepletParameters.Parameter |
addChoice(String name,
Object def,
Object[] items,
Object[] values)
Add a choice (represented as a combobox in request dialog). |
RepletParameters.Parameter |
addDate(String name,
Date def)
Add a date parameter |
RepletParameters.Parameter |
addDateTime(String name,
Date def)
Add a date and time parameter |
RepletParameters.Parameter |
addList(String name,
Object[] def,
Object[] items)
Add a list (represented as a scrollable list in request dialog). |
RepletParameters.Parameter |
addList(String name,
Object[] def,
Object[] items,
Object[] values)
Add a list (represented as a scrollable list in request dialog). |
RepletParameters.Parameter |
addOption(String name,
Object[] def,
Object[] items)
Add an option group (representer as a group of checkboxes). |
RepletParameters.Parameter |
addOption(String name,
Object[] def,
Object[] items,
Object[] values)
Add an option group (representer as a group of checkboxes). |
void |
addParameter(RepletParameters.Parameter param)
Add a parameter to the list. |
RepletParameters.Parameter |
addParameter(String name,
Object def,
Format fmt)
Add a text parameter. |
RepletParameters.Parameter |
addPassword(String name)
Add a password field |
RepletParameters.Parameter |
addRadio(String name,
Object def,
Object[] items)
Add a radio button group (representer as a group of radio buttons). |
RepletParameters.Parameter |
addRadio(String name,
Object def,
Object[] items,
Object[] values)
Add a radio button group (representer as a group of radio buttons). |
RepletParameters.Parameter |
addTextArea(String name,
String def,
int rows,
int cols)
Add a multi-line text parameter. |
RepletParameters.Parameter |
addTime(String name,
Date def)
Add a time parameter. |
void |
clear()
Remove all parameters. |
Object |
clone()
Make a copy of this parameter definition. |
RepletParameters |
clone(String name)
Clone this parameters specification with a different request name. |
boolean |
containsParameter(String name)
Test if contains the specified parameter. |
RepletParameters.Parameter |
getParameter(int n)
Get the specified parameter. |
RepletParameters.Parameter |
getParameter(String name)
Get the parameter with the specified name. |
int |
getParameterCount()
Get the number of parameters. |
Vector |
getParameters()
Get all the parameters. |
String |
getParameterSheet()
Get parameter sheet. |
String |
getRequestDialogClass()
Get the request dialog class name. |
String |
getRequestDialogHTML()
Get the request dialog HTML resource. |
Dimension |
getRequestDialogHTMLSize()
Get the request dialog HTML size, it may be null. |
String |
getRequestName()
Get the request name. |
int |
getVisibleParameterCount()
Get the number of visible parameters. |
Vector |
getVisibleParameters()
Get the visible parameters. |
void |
removeParameter(String name)
Remove a parameter from the parameter definition. |
void |
setAlias(String name,
String alias)
Set an alias for a parameter. |
void |
setParameterSheet(String psheet)
Set parameter sheet. |
void |
setRequestDialogClass(String cls)
Set the request dialog class name. |
void |
setRequestDialogHTML(String html)
Set the request dialog HTML. |
void |
setRequestDialogHTMLSize(Dimension size)
Set the Request Dialog size. |
void |
setRequestName(String name)
Set the request name. |
void |
setToolTip(String name,
String toolTip)
Set the toolTip for a parameter. |
void |
setVisible(String name,
boolean visible)
Set the visibility of a parameter. |
String |
toString()
To string. |
String |
toString2()
To string. |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public RepletParameters(String name)
name - request name.| Method Detail |
|---|
public String getRequestName()
public void setRequestName(String name)
public void setRequestDialogClass(String cls)
cls - fully qualified class name.public String getRequestDialogClass()
public void setParameterSheet(String psheet)
public String getParameterSheet()
public void setRequestDialogHTML(String html)
If the dialog is set, the HTML is used for prompting user input when viewing reports with a browser. Otherwise, a request dialog is generated by the report engine. The HTML page must contain a form meeting the following requirements:
- the form action field must be '$(servlet.uri)' - the form target field must be '$(request.target)' - contains a hidden field with name 'ID' and value '$(replet.id)' - contains a hidden field with name 'req' and value '$(request.name)' - contains a hidden field with name 'op' and value 'Generate'. - contains fields for the parameter values, where the name of each field must match the parameter field name.
The form is responsible for closing the form window when the form is submitted. This can be done by using a onClick handler.
html - html file resource name.public String getRequestDialogHTML()
public void setRequestDialogHTMLSize(Dimension size)
size - - the size of this dialog.public Dimension getRequestDialogHTMLSize()
public void setAlias(String name,
String alias)
name - parameter name.alias - parameter label.
public void setToolTip(String name,
String toolTip)
name - parameter name.toolTip - parameter toolTip.
public void setVisible(String name,
boolean visible)
name - parameter name.visible - false to hide a parameter.
public RepletParameters.Parameter addParameter(String name,
Object def,
Format fmt)
name - name of the parameter.def - default value.fmt - format, null to ignore.
public RepletParameters.Parameter addTextArea(String name,
String def,
int rows,
int cols)
name - name of the parameter.def - default value.rows - number of rows.cols - number of columns.public RepletParameters.Parameter addPassword(String name)
name - name of the parameter.
public RepletParameters.Parameter addBoolean(String name,
boolean def)
name - name of the parameter.def - default value.
public RepletParameters.Parameter addChoice(String name,
Object def,
Object[] items,
Object[] values)
name - name of the parameter.def - default value.items - choice items.values - choice values.
public RepletParameters.Parameter addChoice(String name,
Object def,
Object[] items)
name - name of the parameter.def - default value.items - choice items.
public RepletParameters.Parameter addList(String name,
Object[] def,
Object[] items,
Object[] values)
name - name of the parameter.def - default value.items - choice items.values - choice values.
public RepletParameters.Parameter addList(String name,
Object[] def,
Object[] items)
name - name of the parameter.def - default value.items - choice items.
public RepletParameters.Parameter addRadio(String name,
Object def,
Object[] items,
Object[] values)
name - name of the parameter.def - default value.items - choice items.values - choice values.
public RepletParameters.Parameter addRadio(String name,
Object def,
Object[] items)
name - name of the parameter.def - default value.items - choice items.
public RepletParameters.Parameter addOption(String name,
Object[] def,
Object[] items,
Object[] values)
name - name of the parameter.def - default value.items - choice items.values - choice values.
public RepletParameters.Parameter addOption(String name,
Object[] def,
Object[] items)
name - name of the parameter.def - default value.items - choice items.
public RepletParameters.Parameter addDate(String name,
Date def)
name - name of the parameter.def - default value.
public RepletParameters.Parameter addDateTime(String name,
Date def)
name - name of the parameter.def - default value.
public RepletParameters.Parameter addTime(String name,
Date def)
name - name of the parameter.def - default value.public void addParameter(RepletParameters.Parameter param)
public void clear()
public boolean containsParameter(String name)
public void removeParameter(String name)
public RepletParameters.Parameter getParameter(String name)
name - parameter name.
public RepletParameters.Parameter getParameter(int n)
n - parameter index.public int getParameterCount()
public int getVisibleParameterCount()
public Vector getVisibleParameters()
public Vector getParameters()
public String toString()
toString in class Objectpublic String toString2()
public RepletParameters clone(String name)
public Object clone()
clone in class Object
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||