Style Intelligence v12.0

inetsoft.report
Interface FieldElement

All Superinterfaces:
Cloneable, HyperlinkSupport, PainterElement, ReportElement, Serializable
All Known Subinterfaces:
ButtonElement, CheckBoxElement, ChoiceElement, DateComboElement, ImageButtonElement, ListElement, RadioButtonElement, TextAreaElement, TextFieldElement

public interface FieldElement
extends PainterElement

The FieldElement defines the common API of all field elements.

* Only available in Style Report/EE.


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.
 String getForm()
          Get the name of the form this field is contained in.
 Object getHiddenField(String name)
          Get the value of a hidden field.
 Enumeration getHiddenFieldNames()
          Return the names of all hidden fields in the form.
 String getName()
          Get the name of a field.
 String getOnMouseDown()
          Get web browser onMouseDown java script of the field element.
 String getOnSubmit()
          Get web browser onSubmit java script of the field element.
 String getToolTip()
          Get the toolTip of this element.
 Object getValue()
          Get the value of this field.
 boolean isDisabledOnStage()
          Check if this field is disabled on stage.
 boolean isEnabled()
          Check if this field is enabled.
 boolean isSubmitOnChange()
          Check if this field should submit the form when the value is changed.
 void removeHiddenField(String name)
          Remove a hidden field from a form.
 void setEnabled(boolean enabled)
          Enable or disable this field.
 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 setName(String text)
          Set the field name.
 void setOnMouseDown(String script)
          Set web browser onMouseDown java script of the field element.
 void setOnSubmit(String script)
          Set web browser onSubmit java script of the field element.
 void setSubmitOnChange(boolean submit)
          Set whether to submit the format when the value of the field is changed.
 void setToolTip(String toolTip)
          Set the toolTip for this element.
 void setValue(Object val)
          Set the value of this field.
 
Methods inherited from interface inetsoft.report.PainterElement
getAnchor, getHyperlink, getHyperlinkAreas, getLayout, getMargin, getPainter, getRotation, getSize, getWrapping, setAnchor, setHyperlink, setLayout, setMargin, setPainter, setRotation, setSize, setWrapping
 
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.HyperlinkSupport
getHyperlink, setHyperlink
 

Method Detail

getName

String getName()
Get the name of a field. The name is used as the name of the value when a form is submitted.


setName

void setName(String text)
Set the field name.


getForm

String getForm()
Get the name of the form this field is contained in.


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.


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.


isEnabled

boolean isEnabled()
Check if this field is enabled.


setEnabled

void setEnabled(boolean enabled)
Enable or disable this field.


isDisabledOnStage

boolean isDisabledOnStage()
Check if this field is disabled on stage.

Returns:
true if it is in a ParameterSheet, and is disabled on stage, otherwise return false.

setOnSubmit

void setOnSubmit(String script)
Set web browser onSubmit java script of the field element.

Parameters:
script - the onSubmit java script

getOnSubmit

String getOnSubmit()
Get web browser onSubmit java script of the field element.

Returns:
the onSubmit java script

setOnMouseDown

void setOnMouseDown(String script)
Set web browser onMouseDown java script of the field element.

Parameters:
script - the onMouseDown java script

getOnMouseDown

String getOnMouseDown()
Get web browser onMouseDown java script of the field element.

Returns:
the onMouseDown java script

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.


removeHiddenField

void removeHiddenField(String name)
Remove a hidden field from a form.


getHiddenFieldNames

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


getValue

Object getValue()
Get the value of this field.


setValue

void setValue(Object val)
Set the value of this field.


getToolTip

String getToolTip()
Get the toolTip of this element.

Returns:
the toolTip of this element.

setToolTip

void setToolTip(String toolTip)
Set the toolTip for this element.

Parameters:
toolTip - the toolTip of this element.

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