|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.uql.schema.XVariable
inetsoft.uql.schema.UserVariable
public class UserVariable
An user variable is a variable with a scalar value. The value can either by specified or enter by users at runtime.
| Field Summary | |
|---|---|
static int |
CHECKBOXES
Diplay as checkboxes. |
static int |
COMBOBOX
Display as a combobox. |
static int |
DATE_COMBOBOX
Display as date combobox. |
static int |
LIST
Display as a list. |
static int |
NONE
Display as a text field. |
static int |
RADIO_BUTTONS
Display as radio buttons. |
| Constructor Summary | |
|---|---|
UserVariable()
Create an user variable. |
|
UserVariable(String name)
Create an user variable. |
|
| Method Summary | |
|---|---|
Object |
clone()
Returns a clone of this object. |
boolean |
equals(Object obj)
Check if equals another object. |
Object |
evaluate(VariableTable vars)
Evaulate the XVariable. |
String |
getAlias()
Get the variable label. |
String |
getChoiceQuery()
Get the name of the query that will be executed to generate a list of values for choices. |
Object[] |
getChoices()
Get the list of choices. |
int |
getDisplayStyle()
Get the display style. |
String |
getToolTip()
Get the variable toolTip. |
Object[] |
getTypedValues()
Get the list of values. |
XTypeNode |
getTypeNode()
Get the variable value type. |
XValueNode |
getValueNode()
Get the value of this variable. |
Object[] |
getValues()
Get the list of values. |
int |
hashCode()
Get the hash code value. |
boolean |
isCustomization()
Check whether this parameter is used as customization parameter of a report. |
boolean |
isEmbedded()
Check if it is an embeded variable from bean or subreport. |
boolean |
isHidden()
Check if the value should be hidden during data entry. |
boolean |
isLocalQuery()
Get local query option. |
boolean |
isLocalWorksheet()
Check if localWorksheet. |
boolean |
isMultipleSelection()
Check if multiple selection is allowed. |
boolean |
isPrompt()
Check is the value of the variable needs to be enter by users. |
boolean |
isSortValue()
Get the value of sortValue. |
boolean |
isUsedInOneOf()
Check is used in one of condition. |
protected void |
parseAttributes(Element elem)
Parse attributes. |
protected void |
parseContents(Element elem)
Parse contents. |
void |
parseXML(Element elem)
Parse the XML element that contains information on this variable. |
void |
setAlias(String label)
Set the label for the user field when prompting users. |
void |
setChoiceQuery(String query)
Set the name of the query that will be executed to generate a list of values for choices. |
void |
setChoices(Object[] choices)
Set a list of items to choose the value from. |
void |
setCustomization(boolean customize)
Set whether this parameter is used as customization parameter of a report. |
void |
setEmbedded(boolean embedded)
Set whether to prompt users for the value. |
void |
setHidden(boolean hidden)
Set if the contents of the variable should be hidden. |
void |
setLocalQuery(boolean local)
Set local query option. |
void |
setLocalWorksheet(Boolean localw)
Set if current query is localWorksheet. |
void |
setMultipleSelection(boolean multi)
Set whether to allow multiple selection. |
void |
setPrompt(boolean prompt)
Set whether to prompt users for the value. |
void |
setSortValue(boolean sortValue)
Set the value of sortValue. |
void |
setToolTip(String toolTip)
Set the toolTip for the user field when prompting users. |
void |
setTypeNode(XTypeNode xtype)
Set the type of this variable. |
void |
setUsedInOneOf(boolean used)
Set if current used in one of condition. |
void |
setValueNode(XValueNode value)
Set the value of this variable. |
void |
setValues(Object[] values)
Set a list of values to choose the value from. |
String |
toString()
Get the "$(name)" as the variable representation. |
protected void |
writeAttributes(PrintWriter writer)
Write attributes. |
protected void |
writeContents(PrintWriter writer)
Write contents. |
void |
writeXML(PrintWriter writer)
Write the variable XML representation. |
| Methods inherited from class inetsoft.uql.schema.XVariable |
|---|
getName, getSource, parse, setName, setSource |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final int NONE
public static final int COMBOBOX
public static final int LIST
public static final int RADIO_BUTTONS
public static final int CHECKBOXES
public static final int DATE_COMBOBOX
| Constructor Detail |
|---|
public UserVariable()
public UserVariable(String name)
| Method Detail |
|---|
public void setPrompt(boolean prompt)
prompt - true if the value should be entered by users at
runtime.public boolean isPrompt()
public void setEmbedded(boolean embedded)
embedded - true if it is an embeded variable from bean or subreport.public boolean isEmbedded()
public int getDisplayStyle()
public void setCustomization(boolean customize)
public boolean isCustomization()
public void setAlias(String label)
public String getAlias()
public String getToolTip()
public void setToolTip(String toolTip)
public void setChoices(Object[] choices)
public Object[] getChoices()
public void setValues(Object[] values)
public Object[] getValues()
public void setSortValue(boolean sortValue)
public boolean isSortValue()
public Object[] getTypedValues()
public void setValueNode(XValueNode value)
public XValueNode getValueNode()
public void setTypeNode(XTypeNode xtype)
xtype - value type, one of the value defined in XSchema.public XTypeNode getTypeNode()
public Object evaluate(VariableTable vars)
evaluate in class XVariablepublic void setHidden(boolean hidden)
public boolean isHidden()
public void setMultipleSelection(boolean multi)
public boolean isMultipleSelection()
public void setChoiceQuery(String query)
query - the query name or column/attribute name.public String getChoiceQuery()
public void setLocalQuery(boolean local)
public boolean isLocalQuery()
public void writeXML(PrintWriter writer)
protected void writeAttributes(PrintWriter writer)
writeAttributes in class XVariablewriter - the specified print writer.protected void writeContents(PrintWriter writer)
writer - the specified print writer.
public void parseXML(Element elem)
throws Exception
elem - the specified xml element.
Exception
protected void parseAttributes(Element elem)
throws Exception
parseAttributes in class XVariableelem - the specified xml element.
Exception
protected void parseContents(Element elem)
throws Exception
elem - the specified xml element.
Exceptionpublic Object clone()
clone in class XVariablepublic boolean equals(Object obj)
equals in class Objectpublic int hashCode()
hashCode in class Objectpublic void setLocalWorksheet(Boolean localw)
public boolean isLocalWorksheet()
public void setUsedInOneOf(boolean used)
public boolean isUsedInOneOf()
public String toString()
toString 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 | ||||||||