Package overit.geocall.basic.ui.control

Class TextButton

java.lang.Object

overit.geocall.platform.ui.UINode

overit.geocall.ui.Component

overit.geocall.ui.Control

overit.geocall.basic.ui.control.Button

overit.geocall.basic.ui.control.ExitButton

overit.geocall.basic.ui.control.TextButton

All Implemented Interfaces:

Serializable, overit.geocall.marks.MethodExposer, overit.geocall.marks.NameExposer, Badgeable, Hideable, Identified, Tool, overit.geocall.ux.configurability.UIConfigurable, overit.geocall.ux.edm.ModelConfigurable

@Component
public class TextButton
extends ExitButton

This component extends ExitButton and must be used to add an input element in read only mode to the left of the button (it is always visible). The input element can be filled either with a static value or with the value of a field present in the HashGetter passed to the form to which it belongs (see Control.getValues()).
Moreover it is possible add above this element a label that is subject to translation.
In case the ICON attribute is not set (see setICON()), this element provides the "ok" icon as default.

See Also:

• Serialized Form

GCApi:

component

Nested Class Summary

Nested classes/interfaces inherited from class overit.geocall.ui.Component

Component.Configurable, Component.ConfigurableAttribute, Component.ConfigurableAttributes, Component.FilterCriteria, Component.Registry

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_field
protected String	_size
protected String	_textlabel
protected String	_value

Fields inherited from class overit.geocall.basic.ui.control.Button

_anchor, _blankvisible, _form, _htmlid, _labelName, _lastshow, _msg, _param, _prompt, _rovisible, _type, _visible, promptEmpty

Fields inherited from class overit.geocall.ui.Control

_blank, _cleaner, _dblink, _enabled, _ro, _title, altEventIconsList, altIcon, ariaDescription, ariaLabel, badge, badgeformat, FILTER_PREFIXES, LABEL_ATTRIBUTE, LABEL_IN_LINE_ATTRIBUTE, STATE_BLANK, STATE_NORMAL, STATE_RO, STATE_ROBLANK

Fields inherited from class overit.geocall.ui.Component

_basic, _childrenContainers, _currentId, _gridalign, _gridcols, _gridrows, _gridvalign, _iconElement, _id, _keylabel, _label, _layoutName, _name, _parentContainer, _registryName, _shortcut, _tabindex, _transformations, _valuesContainer, aliasField, BR, configHidden, configuredLabel, configuredLabelInLine, defaultHidden, ELEMENT_BR, ELEMENT_NULL, entityContainer, entityName, extendedField, fullHeight, important, labelInLine, layoutLabel, PIXEL_IMG, safeInlineService

Constructor Summary

Constructors

Constructor	Description
TextButton()	Creates a new instance of TextButton

Method Summary

Modifier and Type	Method	Description
org.apache.ecs.Element	getHtml(EntitySet es)	Returns the html code of the Button
void	setFIELD(String s)	Sets the name of field that must be used to get the value to set on input field
void	setSIZE(String s)	Sets the width of the input field next to the element.
void	setTEXTLABEL(String s)	Sets the label to show above the field.
void	setVALUE(String s)	Sets the static value that must be used to set on input field in the case of the FIELD attribute is not set (see setFIELD()).

Methods inherited from class overit.geocall.basic.ui.control.ExitButton

prepareName, validate

Methods inherited from class overit.geocall.basic.ui.control.Button

areVisibleAttrsBasedOnFunction, getVISIBLE, isImportant, isVisible, prepareLabel, setANCHOR, setBLANKVISIBLE, setDEFAULT, setFORM, setHTMLID, setLABELNAME, setLASTSHOW, setMsg, setMSG, setPARAM, setPrompt, setPROMPT, setPROMPTEMPTY, setROVISIBLE, setVISIBLE

Methods inherited from class overit.geocall.ui.Control

avoidNull, clean, getBadgeFormat, getBadgeValue, getBLANK, getCleaner, getConfigurableProperties, getDAValues, getDBLINK, getKEYLABEL, getLABEL, getRO, getState, getTITLE, getValues, getWM, isEnabled, isEnabledBasedOnFunction, isFunctionEnabled, isRoBasedOnFunction, nameWithNoFilterPrefix, setALTEVENTICON, setALTICON, setARIADESCRIPTION, setARIALABEL, setBADGEFORMAT, setBADGEVALUE, setBLANK, setCLEANER, setConfiguredProperty, setDBLINK, setENABLED, setFUNCTION, setModelProperties, setRO, setTitle, setTITLE

Methods inherited from class overit.geocall.ui.Component

adapt, ajaxQuery, appendAttribute, buildDisplayScript, buildSetupScript, calcKeyLabel, calcLabel, calcShortcut, canBeConfigured, changed, clearConfiguredProperties, componentIterator, componentSize, connect, containerIterator, createAjaxFrame, deprecate, fillSetupScript, generateFlexableFullHeightContainer, generateId, getBASIC, getBoolean, getBoolean, getChildrenComponents, getChildrenContainers, getDefaultLabel, getDefaultLayoutLabel, getEntityContainer, getEntityName, getFullHeight, getGridAlign, getGridCols, getGridRows, getGridVAlign, getHtmlLabel, getHtmlLabel, getIcon, getId, getIdentity, getint, getLayoutLabel, getLayoutName, getNAME, getParentComponent, getParentContainer, getPublishedChildrenList, getRegistryName, getSHORTCUT, getTabIndex, getTeacher, getValuesContainer, getWindow, initChilds, isActivable, isActive, isAliasField, isConfigHidden, isDefaultHidden, isExtendedField, isLabelInLine, onInit, setActivable, setActive, setAliasField, setBASIC, setConfigHidden, setDEFAULTHIDDEN, setEntityName, setExtendedField, setFULLHEIGHT, setGRIDALIGN, setGRIDCOLS, setGRIDROWS, setGRIDVALIGN, setICON, setIdentity, setIMPORTANT, setLabel, setLABEL, setLABELINLINE, setLAYOUTLABEL, setLAYOUTNAME, setNAME, setREGISTRYNAME, setTooltip, setup, setValuesContainer, stringForJs, tabIndexer

Methods inherited from class overit.geocall.platform.ui.UINode

addChild, addChildText, getChildren, getNodeId, getParent, getRoot, getSchema, setNodeId, setParent, setSchema

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface overit.geocall.ui.Badgeable

badgeFormat, makeBadgedIcon

Field Details

_value

protected String _value

_size

protected String _size

_field

protected String _field

_textlabel

protected String _textlabel

Constructor Details

TextButton

public TextButton()

Creates a new instance of TextButton

Method Details

setSIZE

public void setSIZE(String s)

Sets the width of the input field next to the element.

Parameters:

s - String containing the value to set as width.

setFIELD

public void setFIELD(String s)

Sets the name of field that must be used to get the value to set on input field

Parameters:

s - String representing the name of the field

setVALUE

public void setVALUE(String s)

Sets the static value that must be used to set on input field in the case of the FIELD attribute is not set (see setFIELD()).

Parameters:

s - String representing the value

setTEXTLABEL

public void setTEXTLABEL(String s)

Sets the label to show above the field.

Parameters:

s - String to show as label.

getHtml

public org.apache.ecs.Element getHtml(EntitySet es)

Description copied from class: Button

Returns the html code of the Button

Overrides:

getHtml in class Button

Parameters:

es - The EntitySet to which the element belongs

Returns:

The html code of the Button