Class HighlightComponent
java.lang.Object
overit.geocall.platform.ui.UINode
overit.geocall.ui.Component
overit.geocall.ui.Control
overit.geocall.basic.ui.control.NullComponent
overit.geocallapp.wfm.core.ux.schedule.intervention.outcome.HighlightComponent
- 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
Support component to highlight a form section with
a colored bar.
Is used in the outcome container to highlight the outcome sections
that presents some troubles during the validation
- Since:
- 9.2
- See Also:
- GCApi:
- component
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe available sides for the highlight barNested 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 booleanprotected Stringprotected StringFields inherited from class overit.geocall.basic.ui.control.NullComponent
_fullsize, _visibleFields 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.ElementAbstract method that must be extended and returns the html code of the ComponentGets the registry name of this componentbooleanSay if the component is highlighted or notvoidsetBORDERWIDTH(String borderwidth) Sets the highlight bar width in pixelsvoidSets the highlight bar colorvoidSets the highlight status of the container.voidsetHIGHLIGHTLABEL(String highlightlabel) Sets an alternative label to show when the component is highlightedvoidSets which side of the section should presents the highlight barMethods inherited from class overit.geocall.basic.ui.control.NullComponent
isVisible, setFULLSIZE, setVISIBLEMethods 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, isImportant, isRoBasedOnFunction, nameWithNoFilterPrefix, setALTEVENTICON, setALTICON, setARIADESCRIPTION, setARIALABEL, setBADGEFORMAT, setBADGEVALUE, setBLANK, setCLEANER, setConfiguredProperty, setDBLINK, setENABLED, setFUNCTION, setModelProperties, 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, getDefaultLayoutLabel, getEntityContainer, getEntityName, getFullHeight, getGridAlign, getGridCols, getGridRows, getGridVAlign, getHtmlLabel, getHtmlLabel, getIcon, getId, getIdentity, getint, getLayoutLabel, getLayoutName, getNAME, getParentComponent, getParentContainer, getPublishedChildrenList, 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, 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, makeBadgedIconMethods inherited from interface overit.geocall.ui.Hideable
getVISIBLE
-
Field Details
-
color
-
borderwidth
-
side
-
highlight
protected boolean highlight -
highlightlabel
-
-
Constructor Details
-
HighlightComponent
public HighlightComponent()
-
-
Method Details
-
setCOLOR
Sets the highlight bar color- Parameters:
color- the CSS color of the highlight bar
-
setBORDERWIDTH
Sets the highlight bar width in pixels- Parameters:
borderwidth- the highlight bar in pixels
-
setSIDE
Sets which side of the section should presents the highlight bar- Parameters:
side- the side of the section that should presents the highlight bar- See Also:
-
setHIGHLIGHT
Sets the highlight status of the container.- Parameters:
h- A string that represents a boolean value ("true" or "1", "false" or "0")
-
isHiglighted
public boolean isHiglighted()Say if the component is highlighted or not- Returns:
- true if the component is highlighted, false otherwise.
-
setHIGHLIGHTLABEL
Sets an alternative label to show when the component is highlighted- Parameters:
highlightlabel- the label to show when the component is highlighted
-
getRegistryName
Gets the registry name of this component- Overrides:
getRegistryNamein classComponent- Returns:
- the registry name of this component
-
getHtml
Description copied from class:ComponentAbstract method that must be extended and returns the html code of the Component- Overrides:
getHtmlin classNullComponent- Parameters:
es- TheEntitySetto which the element belongs- Returns:
- The html of the Component
-