Package overit.geocall.basic.ui.control
Class ColumnInput
java.lang.Object
overit.geocall.platform.ui.UINode
overit.geocall.ui.Component
overit.geocall.ui.Control
overit.geocall.basic.ui.control.Column
overit.geocall.basic.ui.control.ColumnInput
- All Implemented Interfaces:
Serializable,overit.geocall.marks.MethodExposer,overit.geocall.marks.NameExposer,Badgeable,Hideable,ValueValidator,Identified,Tool,overit.geocall.ux.configurability.UIConfigurable,overit.geocall.ux.edm.ModelConfigurable
- Direct Known Subclasses:
ColumnInputBoolean,ColumnInputMulti,ColumnInputRegExp
This component extends
Column and must be used to insert a input
field as a column.- See Also:
- 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
FieldsModifier and TypeFieldDescriptionprotected Stringprotected Stringprotected Stringprotected Stringprotected booleanprotected booleanprotected intprotected Stringprotected Stringprotected Stringprotected booleanprotected booleanprotected Stringprotected intprotected booleanprotected intFields inherited from class overit.geocall.basic.ui.control.Column
_align, _bkgColorFirst, _bkgColorName, _blankvisible, _breakChars, _colorIndex, _columnorder, _descorder, _descorderQuery, _draggable, _droppable, _errorvalue, _ffGroup, _ffName, _ffTitle, _footer, _group, _groupname, _groupObject, _heading, _headTitle, _key, _labelspan, _minWidth, _msgErrore, _order, _orderQuery, _rovisible, _rowspan, _stuck, _td, _tdColor, _titleFormat, _tmColorSwitch, _userHidden, _valign, _value, _visible, _width, ALIGN_ATTRIBUTE, configuredAlign, configuredDescOrder, configuredGroup, configuredMinWidth, configuredOrder, configuredRowInLine, configuredStuck, configuredTruncate, configuredValign, configuredWidth, GROUP_ATTRIBUTE, inline, MIN_WIDTH_ATTRIBUTE, ORDER_ASC_VALUE, ORDER_ATTRIBUTE, ORDER_DESC_VALUE, ORDER_EITHER_VALUE, ROW_IN_LINE_ATTRIBUTE, STUCK_ATTRIBUTE, text, truncate, TRUNCATE_ATTRIBUTE, VERTICAL_ALIGN_ATTRIBUTE, WIDTH_ATTRIBUTEFields 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_ROBLANKFields 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 -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcheckAutoEvent(org.apache.ecs.html.Input i) Deprecated.protected voidcheckAutoEvent(org.apache.ecs.html.Input i, int row) voidconnect()protected voiddefaultAttributes(org.apache.ecs.html.Input i, boolean ro, int row) org.apache.ecs.ElementgetHtmlRow(EntitySet es, int row, int pagerow, ArrayList al) Returns the html element that defines the rowprotected Stringprotected Stringprotected StringprepareName(int row) protected Stringprotected voidvoidSet an event on the field that is launched when the field lose the focus.voidDefines the name of the anchor that is used to reposition the scrolling of the page following the execution of the autoevent associated with the Column.voidSet the message that will appear into a javascript pop up when the autoevent is triggered.voidSet the value that will be passed to thehash getteras a parameter when the autoevent is triggered.voidIndicates if the field is the one that has the focus.voidsetINDEXED(String s) Sets how to build the key for this column.voidSets the maxlength html attribute of the input field.voidSets the message that appears when the user tries to submit a value that is not valid.voidSets the message that appears when the user tries to submit a value that is not valid.voidsetNOTNULL(String s) Set the value for thenotnullattributevoidSets the placeholder, the short hint that usually describes the expected value that appears in the field before the user enters a value.voidSets the placeholder, the short hint that usually describes the expected value that appears in the field before the user enters a value.voidSets the html size attribute of the input fieldvoidChange the use of tab when the focus is on this field.protected voidsetup()Setup the Componentprotected Doubleprotected voidprotected voidvalidateChangingValue(String name, Object value, boolean strong, Map arriving) protected voidvalidateConcreteValue(String name, Object value, boolean strong, Map arriving) protected voidvalidateNotNull(String name, Object value, boolean strong, Map arriving) protected voidvalidateUnchangingValue(String name, Object value, Object published, boolean strong, Map arriving) voidvalidateValue(String name, Object value, boolean strong, Map arriving) Makes the validation to avoid tampering values of a component and it's value.
When a submit event to the server is triggered, is checked that the component is in the validator set, the value is not changed (if the component is RO), the value is changed with an allow value ecc ecc.Methods inherited from class overit.geocall.basic.ui.control.Column
freeResources, getAlign, getCellContent, getColumnOrder, getConfigurableProperties, getDescOrder, getDraggable, getDroppable, getGroup, getHeadControls, getHeadControls, getHeadLabel, getHtml, getHtmlFoot, getLABELSPAN, getLayoutName, getMinWidth, getOrder, getRowInLine, getStuck, getTD, getTD, getTD, getTDColor, getTF, getTruncate, getUserHidden, getVAlign, getVISIBLE, getWidth, groupable, grouped, isHiddenByConfiguration, isUserDraggable, isUserHideable, isVisible, newGroup, setALIGN, setBKGCOLORFIRST, setBKGCOLORNAME, setBKGCOLORSWITCH, setBLANKVISIBLE, setBREAKCHARS, setConfiguredProperty, setDEFAULTHIDDEN, setDESCORDER, setDESCORDERQUERY, setDRAGGABLE, setDROPPABLE, setERRORVALUE, setFOOTER, setGROUP, setGROUPNAME, setHEADING, setHEADTITLE, setINLINE, setKEY, setLABELSPAN, setMINWIDTH, setMinWidthAndWidth, setModelProperties, setORDER, setORDERFIELD, setORDERQUERY, setROVISIBLE, setSTUCK, setTEXT, setTITLEFORMAT, setTITLENAME, setTooltipAndStyleOnLabel, setTRUNCATE, setupMetaData, setupTDColor, setupTitle, setUserHidden, setVALIGN, setVALUE, setVISIBLE, setWIDTHMethods inherited from class overit.geocall.ui.Control
avoidNull, clean, getBadgeFormat, getBadgeValue, getBLANK, getCleaner, getDAValues, getDBLINK, getKEYLABEL, getLABEL, getRO, getState, getTITLE, getValues, getWM, isEnabled, isEnabledBasedOnFunction, isFunctionEnabled, isImportant, isRoBasedOnFunction, nameWithNoFilterPrefix, setALTEVENTICON, setALTICON, setARIADESCRIPTION, setARIALABEL, setBADGEFORMAT, setBADGEVALUE, setBLANK, setCLEANER, setDBLINK, setENABLED, setFUNCTION, setRO, setTitle, setTITLEMethods inherited from class overit.geocall.ui.Component
adapt, ajaxQuery, appendAttribute, buildDisplayScript, buildSetupScript, calcKeyLabel, calcLabel, calcShortcut, canBeConfigured, changed, clearConfiguredProperties, componentIterator, componentSize, containerIterator, createAjaxFrame, deprecate, fillSetupScript, generateFlexableFullHeightContainer, generateId, getBASIC, getBoolean, getBoolean, getChildrenComponents, getChildrenContainers, getDefaultLabel, getEntityContainer, getEntityName, getFullHeight, getGridAlign, getGridCols, getGridRows, getGridVAlign, getHtmlLabel, getHtmlLabel, getIcon, getId, getIdentity, getint, getLayoutLabel, getNAME, getParentComponent, getParentContainer, getPublishedChildrenList, getRegistryName, getSHORTCUT, getTabIndex, getTeacher, getValuesContainer, getWindow, initChilds, isActivable, isActive, isAliasField, isConfigHidden, isDefaultHidden, isExtendedField, isLabelInLine, onInit, setActivable, setActive, setAliasField, setBASIC, setConfigHidden, setEntityName, setExtendedField, setFULLHEIGHT, setGRIDALIGN, setGRIDCOLS, setGRIDROWS, setGRIDVALIGN, setICON, setIdentity, setIMPORTANT, setLabel, setLABEL, setLABELINLINE, setLAYOUTLABEL, setLAYOUTNAME, setNAME, setREGISTRYNAME, setTooltip, setValuesContainer, stringForJs, tabIndexerMethods inherited from class overit.geocall.platform.ui.UINode
addChild, addChildText, getChildren, getNodeId, getParent, getRoot, getSchema, setNodeId, setParent, setSchemaMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface overit.geocall.ui.Badgeable
badgeFormat, makeBadgedIcon
-
Field Details
-
_notnull
protected boolean _notnull -
_numeric
protected boolean _numeric -
_tabbed
protected boolean _tabbed -
_defaultFocus
protected boolean _defaultFocus -
_size
protected int _size -
_msg
-
_indexed
protected boolean _indexed -
_autoevent
-
_autoeventparam
-
_autoeventmsg
-
_autoeventanchor
-
_placeholder
-
_maxlength
protected int _maxlength -
workingRow
protected int workingRow -
_msgErroreCampo
-
_msgCampoObbligatorio
-
-
Constructor Details
-
ColumnInput
public ColumnInput()Creates a new instance of ColumnInput
-
-
Method Details
-
setPLACEHOLDER
Sets the placeholder, the short hint that usually describes the expected value that appears in the field before the user enters a value. The value will be translated.- Parameters:
s- The string that will appear as a placeholder in the field
-
setDEFAULTFOCUS
Indicates if the field is the one that has the focus.
If you want to force the focus on a specific field you must set the attribute to true, and every other field that appears before that one in the form must have this attribute set to false- Parameters:
s- A string that represents a boolean value ("true" or "1", "false" or "0").
If the string is not recognized as a boolean value, it will be used the default value, that is false
-
setNOTNULL
Set the value for thenotnullattribute- Parameters:
s- A string that represents a boolean value ("true" or "1", "false" or "0").
If the string is not recognized as a boolean value, it will be used the default value, that is false
-
setMSG
Sets the message that appears when the user tries to submit a value that is not valid. It is used in classes that extend ColumnInpu. The value will be translated.- Parameters:
s- The string that contains the message
-
setMAXLENGTH
Sets the maxlength html attribute of the input field.
By setting this attribute, the user will not be allowed to enter a content longer thanmaxlengthin the field- Parameters:
s- The maxlength attribute expressed in number of characters
-
setSIZE
Sets the html size attribute of the input field- Parameters:
s- The size attribute expressed in number of characters
-
setTABBED
Change the use of tab when the focus is on this field. If this attribute is true, when the user press tab button, the focus moves to the input field of this column but of the next row. If the value is false, the behavior of the focus is standard: when the user press tab button the focus moves to the next field of the same row.- Parameters:
s- The string that contains the boolean value. If it is not valid, will be set with default value: "false".
-
setAUTOEVENT
Set an event on the field that is launched when the field lose the focus.- Parameters:
s- Name of the event to launch when the field lose the focus.
-
setAUTOEVENTANCHOR
Defines the name of the anchor that is used to reposition the scrolling of the page following the execution of the autoevent associated with the Column. The name must correspond to the value of a reference attribute of aGridor aSection, set using the appropriate set methods (Grid.setREF(String),Section.setREF(String)).
The relocation mechanism works only with non-Ajax events, the ones that reload the page.- Parameters:
s- The name of the anchor
-
setAUTOEVENTPARAM
Set the value that will be passed to thehash getteras a parameter when the autoevent is triggered. The key of the value into hash getter will be"param"- Parameters:
s- Value passed to thehash getteras a parameter
-
setAUTOEVENTMSG
Set the message that will appear into a javascript pop up when the autoevent is triggered.- Parameters:
s- Message to show into the javascript pop up.
-
setINDEXED
Sets how to build the key for this column. If the value is true, all the values have been passed to the submit and the key to access of the value is build as the append of the name of the column and the number of row. If the value is false, only first value will be passed to the submit with key equal to the name of the column.- Parameters:
s- The string that contains the boolean value. If it is not valid, will be set with default value: "false".
-
setup
protected void setup()Description copied from class:ComponentSetup the Component -
connect
public void connect() -
registerValidators
protected void registerValidators() -
validate
-
validate
-
prepareName
-
prepareName
-
indexedName
-
prepareValue
-
checkAutoEvent
Deprecated.- Parameters:
i- UsecheckAutoEvent(Input, int)
-
checkAutoEvent
protected void checkAutoEvent(org.apache.ecs.html.Input i, int row) -
getHtmlRow
Description copied from class:ColumnReturns the html element that defines the row- Overrides:
getHtmlRowin classColumn- Parameters:
es- TheEntitySetto which the element belongsrow- The number of the rowpagerow- The number ofd the pageal- The list of values of the row- Returns:
- The html element that defines the row
-
defaultAttributes
protected void defaultAttributes(org.apache.ecs.html.Input i, boolean ro, int row) -
setMsg
Sets the message that appears when the user tries to submit a value that is not valid. It is used in classes that extend ColumnInpu. The value will not be translated.- Parameters:
s- The string that contains the message
-
setPlaceholder
Sets the placeholder, the short hint that usually describes the expected value that appears in the field before the user enters a value. The value will not be translated.- Parameters:
s- The string that will appear as a placeholder in the field
-
validateValue
public void validateValue(String name, Object value, boolean strong, Map arriving) throws ValidationException Description copied from interface:ValueValidatorMakes the validation to avoid tampering values of a component and it's value.
When a submit event to the server is triggered, is checked that the component is in the validator set, the value is not changed (if the component is RO), the value is changed with an allow value ecc ecc.- Specified by:
validateValuein interfaceValueValidator- Parameters:
name- The name associated to the component to validate.value- The value to validatestrong- Defines if the validation must be strong or not (for not null component).arriving- AMapwith all the components (and their values) arriving from submit.- Throws:
ValidationException- Raised if the validation failed.
-
validateUnchangingValue
protected void validateUnchangingValue(String name, Object value, Object published, boolean strong, Map arriving) throws ValidationException - Throws:
ValidationException
-
validateChangingValue
protected void validateChangingValue(String name, Object value, boolean strong, Map arriving) throws ValidationException - Throws:
ValidationException
-
validateNotNull
protected void validateNotNull(String name, Object value, boolean strong, Map arriving) throws ValidationException - Throws:
ValidationException
-
validateConcreteValue
protected void validateConcreteValue(String name, Object value, boolean strong, Map arriving) throws ValidationException - Throws:
ValidationException
-
getDefaultLayoutLabel
- Overrides:
getDefaultLayoutLabelin classColumn
-
checkAutoEvent(Input, int)