Style Intelligence v12.0

inetsoft.report
Interface ParameterElement

All Superinterfaces:
inetsoft.report.internal.BindableElement, inetsoft.report.internal.BindableTabularElement, Cloneable, CompositeElement, inetsoft.report.internal.NonScalar, ReportElement, Serializable, inetsoft.report.internal.Tabular

public interface ParameterElement
extends CompositeElement, inetsoft.report.internal.BindableTabularElement

A parameter element is the element which is in adhoc parameter sheet.


Field Summary
 
Fields inherited from interface inetsoft.report.ReportElement
AGGREGATE, AUTOSIZE, GROW, LOCAL_QUERY, QUERY, XNODEPATH
 
Method Summary
 boolean containsHiddenField(String name)
          Check if a hidden field is set.
 Object[] getChoices()
          Return the text in the text lens.
 String getDefaultValue()
          Get the default value of the parameter.
 String getDependence()
          Get the dependent parameter name of the parameter.
 String getForm()
          Get the name of the form.
 Object getHiddenField(String name)
          Get the value of a hidden field.
 Enumeration getHiddenFieldNames()
          Return the names of all hidden fields in the form.
 String getLabel()
          Get the label of the parameter.
 int getMaxLength()
          Get the maximum number of characters a parameter allows.
 String getName()
          Get the name of the parameter.
 Object[] getSelectedItems()
          Get the selected items.
 Size getSize()
          Set the size of paintable element contained in parameter element.
 int getStyle()
          Get the display style of the parameter.
 String getToolTip()
          Get the toolTip of the parameter.
 XTypeNode getTypeNode()
          Get the parameter value type.
 Object[] getValues()
          Get the list of values.
 boolean isOptional()
          Check if this field is optional.
 boolean isSubmitOnChange()
          Check if this field should submit the form when the value is changed.
 void setChoices(Object[] choices)
          Set the text contained in this text element.
 void setDefaultValue(String value)
          Set the default value of a parameter.
 void setDependence(String dependence)
          Set the dependent parameter name of a parameter.
 void setForm(String form)
          Set name of the form that contains this element.
 void setHiddenField(String name, Object value)
          Set (add) a hidden field to the form.
 void setLabel(String name)
          Set the label of a parameter.
 void setMaxLength(int max)
          Set the maximum number of characters a parameter allows.
 void setName(String name)
          Set the name of a parameter.
 void setOptional(boolean optional)
          Set this field Optional or not.
 void setSelectedItems(Object[] selected)
          Set the selected items.
 void setSize(Size size)
          Set the size of paintable element contained in parameter element.
 void setStyle(int style)
          Set the display style of a parameter.
 void setSubmitOnChange(boolean submit)
          Set whether to submit the format when the value of the field is changed.
 void setToolTip(String name)
          Set the toolTip of a parameter.
 void setTypeNode(XTypeNode xtype)
          Set the type of the parameter.
 void setValues(Object[] values)
          Set a list of values to choose the value from.
 
Methods inherited from interface inetsoft.report.CompositeElement
getComposite, isLineAfter, setComposite, setLineAfter
 
Methods inherited from interface inetsoft.report.internal.BindableTabularElement
applyFilters, applyVisible, getFilterBaseTable, getFilterTable, getVisibleTable
 
Methods inherited from interface inetsoft.report.internal.NonScalar
getBaseTable, getTable, getTopTable, resetFilter, setTable
 
Methods inherited from interface inetsoft.report.internal.BindableElement
getBindingAttr, getSourceAttr, isSourceBlank, setBindingAttr, updateFormulas, updateReportFormulas
 
Methods inherited from interface inetsoft.report.ReportElement
clone, getAlignment, getBackground, getCSSClass, getFont, getForeground, getFullName, getID, getIndent, getOnClick, getPreferredSize, getProperty, getPropertyNames, getScript, getSpacing, getTarget, getType, getUserObject, isHideOnPrint, isKeepWithNext, isVisible, setAlignment, setBackground, setContext, setCSSClass, setFont, setForeground, setFullName, setHideOnPrint, setID, setIndent, setKeepWithNext, setOnClick, setProperty, setScript, setSpacing, setTarget, setUserObject, setVisible
 
Methods inherited from interface inetsoft.report.internal.Tabular
isEmbedded, setData, setEmbedded
 

Method Detail

setName

void setName(String name)
Set the name of a parameter.


getName

String getName()
Get the name of the parameter.


getForm

String getForm()
Get the name of the form.


setForm

void setForm(String form)
Set name of the form that contains this element. The form name is used to group fields into one form. All elements on a report with the same form name are grouped into one form.


setLabel

void setLabel(String name)
Set the label of a parameter.


getLabel

String getLabel()
Get the label of the parameter.


setToolTip

void setToolTip(String name)
Set the toolTip of a parameter.


getToolTip

String getToolTip()
Get the toolTip of the parameter.


isOptional

boolean isOptional()
Check if this field is optional.


setOptional

void setOptional(boolean optional)
Set this field Optional or not.


setTypeNode

void setTypeNode(XTypeNode xtype)
Set the type of the parameter.


getTypeNode

XTypeNode getTypeNode()
Get the parameter value type.


getMaxLength

int getMaxLength()
Get the maximum number of characters a parameter allows.


setMaxLength

void setMaxLength(int max)
Set the maximum number of characters a parameter allows.


setDefaultValue

void setDefaultValue(String value)
Set the default value of a parameter.


getDefaultValue

String getDefaultValue()
Get the default value of the parameter.


setDependence

void setDependence(String dependence)
Set the dependent parameter name of a parameter.


getDependence

String getDependence()
Get the dependent parameter name of the parameter.


setStyle

void setStyle(int style)
Set the display style of a parameter.


getStyle

int getStyle()
Get the display style of the parameter.


setSize

void setSize(Size size)
Set the size of paintable element contained in parameter element.


getSize

Size getSize()
Set the size of paintable element contained in parameter element.


setChoices

void setChoices(Object[] choices)
Set the text contained in this text element.


getChoices

Object[] getChoices()
Return the text in the text lens.


setValues

void setValues(Object[] values)
Set a list of values to choose the value from.


getValues

Object[] getValues()
Get the list of values.

Returns:
null if value is not set.

setSelectedItems

void setSelectedItems(Object[] selected)
Set the selected items.


getSelectedItems

Object[] getSelectedItems()
Get the selected items.


isSubmitOnChange

boolean isSubmitOnChange()
Check if this field should submit the form when the value is changed.


setSubmitOnChange

void setSubmitOnChange(boolean submit)
Set whether to submit the format when the value of the field is changed.


setHiddenField

void setHiddenField(String name,
                    Object value)
Set (add) a hidden field to the form.


getHiddenField

Object getHiddenField(String name)
Get the value of a hidden field.


containsHiddenField

boolean containsHiddenField(String name)
Check if a hidden field is set.


getHiddenFieldNames

Enumeration getHiddenFieldNames()
Return the names of all hidden fields in the form.


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