Package overit.geocall.basic.ui.control
Class ColumnSelector
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.ColumnSelector
- 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
This component extends
Column and can be used to select a single row
or multiple row in a ServerTableView or TableView. Multiple row
can be selected through checkboxes if the value of the field multiple is true,
otherwise if is false only a row at a time can be selected through radio buttons.
If the attribute name is not specified this component will use the default event
of the TableView to perform a selection based on the value of multiple. It's
mandatory to declare a selectName in the ServerTableView (or TableView)
to be able to perform a selection.- 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
FieldsFields 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 TypeMethodDescriptionvoidEvery component can add a script to the StringBuilder, script executed when the component is created.protected voidconnect()Returns the current badge format of this element.Returns the current badge value of this element.org.apache.ecs.ElementReturns the html code of the Columnorg.apache.ecs.ElementgetHtmlRow(EntitySet es, int row, int pagerow, ArrayList al) Creates the ColumnSelector elementprotected IconHDgetIcon(boolean selected) Get the icon to usevoidsetBADGEFORMAT(String badgeformat) Sets badge definiing format of this element.voidsetBADGEVALUE(String badge) Sets badge value of this element.voidsetHEADNAME(String headName) Sets the name of the event for the head cell (not the row's cells)voidSets the value of the field multiple.protected voidsetup()Setup the ComponentMethods inherited from class overit.geocall.basic.ui.control.Column
freeResources, getAlign, getCellContent, getColumnOrder, getConfigurableProperties, getDescOrder, getDraggable, getDroppable, getGroup, getHeadControls, getHeadControls, getHeadLabel, 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, getBLANK, getCleaner, getDAValues, getDBLINK, getKEYLABEL, getLABEL, getRO, getState, getTITLE, getValues, getWM, isEnabled, isEnabledBasedOnFunction, isFunctionEnabled, isImportant, isRoBasedOnFunction, nameWithNoFilterPrefix, setALTEVENTICON, setALTICON, setARIADESCRIPTION, setARIALABEL, setBLANK, setCLEANER, setDBLINK, setENABLED, setFUNCTION, setRO, setTitle, setTITLEMethods inherited from class overit.geocall.ui.Component
adapt, ajaxQuery, appendAttribute, buildDisplayScript, 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
-
multiple
protected boolean multiple -
event
-
headName
-
-
Constructor Details
-
ColumnSelector
public ColumnSelector()
-
-
Method Details
-
setup
protected void setup()Description copied from class:ComponentSetup the Component -
connect
protected void connect() -
setHEADNAME
Sets the name of the event for the head cell (not the row's cells)- Parameters:
headName- A string containing the name of the event for the head cell
-
setBADGEVALUE
Sets badge value of this element.
Any values different than "" wil be rendered at a corner of the underlying icon, if any such icon exists.- Overrides:
setBADGEVALUEin classControl- Parameters:
badge- A string that represents the message to be displayed as a badge
-
setBADGEFORMAT
Sets badge definiing format of this element.- Overrides:
setBADGEFORMATin classControl- Parameters:
badgeformat- The value can be c[x] ir d[y] respectively for x characters or y digits
-
getBadgeValue
Description copied from interface:BadgeableReturns the current badge value of this element.- Specified by:
getBadgeValuein interfaceBadgeable- Overrides:
getBadgeValuein classControl- Returns:
- The string that represents the current value of the badge
-
getBadgeFormat
Description copied from interface:BadgeableReturns the current badge format of this element.- Specified by:
getBadgeFormatin interfaceBadgeable- Overrides:
getBadgeFormatin classControl- Returns:
- The string that represents the current format of the badge
-
setMULTIPLE
Sets the value of the field multiple. If the value is true multiple selection is enabled and through checkboxes multiple row can be selected, if its false multiple selection is disabled and only a row at a time can be selected through radio buttons.- Parameters:
s- The boolean value of multiple
-
getHtml
Description copied from class:ColumnReturns the html code of the Column -
buildSetupScript
Description copied from class:ComponentEvery component can add a script to the StringBuilder, script executed when the component is created.- Overrides:
buildSetupScriptin classComponent- Parameters:
sb- The StringBuilder on which we want to add the script
-
getHtmlRow
Creates the ColumnSelector element- Overrides:
getHtmlRowin classColumn- Parameters:
es- TheEntitySetrow- The rowpagerow- The page rowal- The ArrayList- Returns:
- The html of the field
-
getIcon
Get the icon to use- Parameters:
selected- Boolean value that indicates if the row is selected or not- Returns:
- The icon to use
-
getDefaultLayoutLabel
- Overrides:
getDefaultLayoutLabelin classColumn
-