Package overit.geocall.basic.ui.control
Class ColumnDTZ
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.ColumnDTZ
- 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 must be used to represent date,
time and time zone values. It's possible configure the field to show
only components you want.- 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 booleanprotected booleanprotected booleanprotected Stringprotected Stringprotected SimpleDateFormatprotected SimpleDateFormatprotected Stringprotected Stringprotected ForeignFieldprotected Stringprotected Stringstatic final Stringstandard date format accepted as read input (seeSimpleDateFormatstatic final Stringstandard date format accepted as write input (seeSimpleDateFormatstatic final Stringstandard time format accepted as input (seeSimpleDateFormatandsetSDFT(s))Fields 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 TypeMethodDescriptionorg.apache.ecs.ElementgetHtmlFoot(HashGetter footValues) Returns the footer values of the columnorg.apache.ecs.ElementgetHtmlRow(EntitySet es, int row, int pagerow, ArrayList al) Returns the html element that defines the rowbooleanGets if the date component is active or not.booleanGets if the time component is active or not.protected StringprepareValue(Date d, TimeZone tz) voidSet the components to show in field.voidsetModelProperties(@NotNull DataAttribute dataAttribute) Sets the model properties based on the providedDataAttribute.voidIf the field is a part of range, set the prefix to insert before the value.voidSet the field as a part of a time range.voidSet the date format to show in the field or accepted if the user enter the value manually, and date format will be sent to server with submit of the field (seeSimpleDateFormat).voidSet the time format to show in the field or accepted if the user enter the value manually, and time format will be sent to server with submit of the field (seeSimpleDateFormat).protected voidsetup()Setup the ComponentvoidsetupMetaData(DBView dbv) Called to init all the field starting form the DBViewvoidsetZONENAME(String zonename) Set the name of the field to use as time zone field.voidsetZONEVALUE(String zonevalue) Set the time zone component.Methods inherited from class overit.geocall.basic.ui.control.Column
freeResources, getAlign, getCellContent, getColumnOrder, getConfigurableProperties, getDescOrder, getDraggable, getDroppable, getGroup, getHeadControls, getHeadControls, getHeadLabel, getHtml, 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, setORDER, setORDERFIELD, setORDERQUERY, setROVISIBLE, setSTUCK, setTEXT, setTITLEFORMAT, setTITLENAME, setTooltipAndStyleOnLabel, setTRUNCATE, 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, connect, 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
-
_componentDate
protected boolean _componentDate -
_componentTime
protected boolean _componentTime -
_componentZone
protected boolean _componentZone -
_zonename
-
_zonevalue
-
_range
-
SDF_DATE_READ
standard date format accepted as read input (seeSimpleDateFormat- See Also:
-
SDF_DATE_WRITE
standard date format accepted as write input (seeSimpleDateFormat- See Also:
-
SDF_TIME
standard time format accepted as input (seeSimpleDateFormatandsetSDFT(s))- See Also:
-
_sSdfT
-
_sSdfD
-
_sdfD
-
_sdfT
-
hourSystem
-
_prefix
-
-
Constructor Details
-
ColumnDTZ
public ColumnDTZ()
-
-
Method Details
-
setCOMPONENTS
Set the components to show in field. The possible components are date, time and time zone.- Parameters:
s- The string that contains the combination of the three characters to use to configure which components to display:'d': date;'t': time;'z': time zone.
The default component is date.
-
isComponentDateActive
public boolean isComponentDateActive()Gets if the date component is active or not.- Returns:
trueif the date component is active,falseotherwise.
-
isComponentTimeActive
public boolean isComponentTimeActive()Gets if the time component is active or not.- Returns:
trueif the time component is active,falseotherwise.
-
setZONENAME
Set the name of the field to use as time zone field. The field having this attribute is not time zone component, instead the field having the name passed as a parameter must be a time zone field.- Parameters:
zonename- The string that indicate the name of field to use as time zone settings.
-
setZONEVALUE
Set the time zone component. The value to be set must exists or in the package within company.properties or within the time zone database of IANA.- Parameters:
zonevalue- The string that contains the value of time zone to set.
-
setRANGE
Set the field as a part of a time range. It can be an interval of hours or dates. If the field is used as part of a range of dates, the time component of field is not be displayed. The same with the date component in case the field is a part of a time range.- Parameters:
s- String to define which type of range you are defining. Below are the allowed values:
"DATE_FROM": set the start of the date range. If the date isn't set, it is automatically set toDATE_MIN"DATE_TO": set the end of the date range. If the date isn't set, it is automatically set toDATE_MAX"TIME_FROM": set the start of the time range. If the time isn't set, it is automatically set toTIME_MIN"TIME_TO": set the end of the time range. If the time isn't set, it is automatically set toTIME_MAX"FULL": set the range as date and hour passed.
-
setSDFD
Set the date format to show in the field or accepted if the user enter the value manually, and date format will be sent to server with submit of the field (seeSimpleDateFormat). If it isn't set the default value is the value of the key"DATE_FORMAT_WRITE"in dictionary. If this also does not exits, set the format with the default value:""dd/MM/yyyy""- Parameters:
s- The string of the date format.
-
setSDFT
Set the time format to show in the field or accepted if the user enter the value manually, and time format will be sent to server with submit of the field (seeSimpleDateFormat). If it isn't set the default value is""HH:mm"".- Parameters:
s- The string of the time format.
-
setPREFIX
If the field is a part of range, set the prefix to insert before the value. If the string is null or the prefix is not set, the default value is the translate of the string "FROM" for the from value, and "TO" for the to value.- Parameters:
s- The string to insert as prefix of the value.
-
setup
protected void setup()Description copied from class:ComponentSetup the Component -
setupMetaData
Description copied from class:ColumnCalled to init all the field starting form the DBView- Overrides:
setupMetaDatain classColumn- Parameters:
dbv- The DBView with all the field used in the init
-
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
-
getHtmlFoot
Description copied from class:ColumnReturns the footer values of the column- Overrides:
getHtmlFootin classColumn- Parameters:
footValues- TheHashGetterthat contains the values- Returns:
- The footer values of the column
-
prepareValue
-
setModelProperties
Description copied from interface:overit.geocall.ux.edm.ModelConfigurableSets the model properties based on the providedDataAttribute.- Specified by:
setModelPropertiesin interfaceoverit.geocall.ux.edm.ModelConfigurable- Overrides:
setModelPropertiesin classColumn- Parameters:
dataAttribute- a non-nullDataAttributeused to set model properties
-
getDefaultLayoutLabel
- Overrides:
getDefaultLayoutLabelin classColumn
-