Package overit.geocall.basic.ui.control
Class Column
java.lang.Object
overit.geocall.platform.ui.UINode
overit.geocall.ui.Component
overit.geocall.ui.Control
overit.geocall.basic.ui.control.Column
- 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
- Direct Known Subclasses:
CalendarViewColumn,ColumnBoolean,ColumnButton,ColumnColor,ColumnCurrency,ColumnDate,ColumnDepiction,ColumnDouble,ColumnDrag,ColumnDTZ,ColumnImage,ColumnInput,ColumnIsNull,ColumnLong,ColumnLookup,ColumnLookup2,ColumnMimeIcon,ColumnRangePPMPrediction,ColumnResidualTime,ColumnSelector,ColumnSpan,ColumnStaticView,ColumnSurvey,ColumnSurveyRating,ColumnSwitch,ColumnTime,ColumnWorkOrder,ColumnWorkOrderThematism
@Component
@Configurable
@ConfigurableAttribute(name="ALIGN",label="Align",type="STRING",values={@Value(value="",label="Default"),@Value(value="l",label="Left"),@Value(value="c",label="Center"),@Value(value="r",label="Right")},properties={@Property(key="type",value="string"),@Property(key="fullsize",value="true")}) @ConfigurableAttribute(name="VALIGN",label="Vertical Align",type="STRING",values={@Value(value="",label="Default"),@Value(value="t",label="Top"),@Value(value="c",label="Center"),@Value(value="b",label="Bottom")},properties={@Property(key="type",value="string"),@Property(key="fullsize",value="true")}) @ConfigurableAttribute(name="STUCK",label="Stuck",type="STRING",values={@Value(value="",label="Default"),@Value(value="l",label="Left"),@Value(value="r",label="Right")},properties={@Property(key="type",value="string"),@Property(key="fullsize",value="true")}) @ConfigurableAttribute(name="WIDTH",label="Width",type="LONG",properties={@Property(key="greater",value="-1"),@Property(key="less",value="9223372036854775807")}) @ConfigurableAttribute(name="MINWIDTH",label="Minimum Width",type="LONG",properties={@Property(key="greater",value="-1"),@Property(key="less",value="9223372036854775807")}) @ConfigurableAttribute(name="GROUP",label="Group",type="BOOLEAN") @ConfigurableAttribute(name="ROWINLINE",label="Row in line",type="BOOLEAN") @ConfigurableAttribute(name="TRUNCATE",label="Truncate",type="LONG",properties={@Property(key="greater",value="-1"),@Property(key="less",value="9223372036854775807")}) @ConfigurableAttribute(name="ORDER",label="Order",type="STRING",values={@Value(value="",label="Default"),@Value(value="ASC",label="Ascending"),@Value(value="DESC",label="Descending"),@Value(value="EITHER",label="Bidirectional")},properties={@Property(key="type",value="string"),@Property(key="fullsize",value="true")},onlyExtended=true)
public class Column
extends Control
implements Hideable
This class extends
Each column, for displaying values, must have a name that corresponds to one of the names of a field in the
Control and implements the user interface object that represents a column of a table and
allows to arranges the data of string type in tabular format. Every column must be placed inside a specific
table container, which can be a TableView or a ServerTableView. Each column, for displaying values, must have a name that corresponds to one of the names of a field in the
DBView
that is set to the TableView or ServerTableView to which the column belongs.- 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 charprotected booleanprotected Stringprotected SetPredicateprotected Stringprotected intprotected ColumnOrderprotected booleanprotected Stringprotected Stringprotected Stringprotected Stringprotected ForeignFieldprotected ForeignFieldprotected ForeignFieldprotected Stringprotected booleanprotected Stringprotected Serializableprotected booleanprotected Stringprotected booleanprotected charprotected intprotected Stringprotected booleanprotected Stringprotected SetPredicateprotected intprotected StringUsed to define if a column is a stuck column or not.protected org.apache.ecs.html.TDprotected Stringprotected MapFormatprotected TreeMapprotected booleanprotected charprotected Stringprotected SetPredicateprotected intstatic final Stringprotected Characterprotected Booleanprotected Booleanprotected Integerprotected Booleanprotected Booleanprotected Stringprotected Integerprotected Characterprotected Integerstatic final Stringprotected booleanstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringprotected Stringprotected intstatic final Stringstatic final Stringstatic final StringFields 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 TypeMethodDescriptionvoidchargetAlign()Gets the real align value to apply.protected org.apache.ecs.StringElementReturns theColumnOrderof the columnCollection<overit.geocall.ux.configurability.UIProperty> Gets a set ofUIPropertyobject that represents the configurable UI properties that the object can handle.
EachUIPropertyobject, can be used to retrieve some information about the configurable property, for example it can be used to design the ui xml objects to inject into the properties configurability section of the ResponsiveGrids and TableVies configurability panels.
The property section are those section placed on the left side of the panel and shown when user click on the settings icon of a field to customize its properties.booleanGets the real desc order value to apply.booleangetGroup()Gets if the column is set to grouping its rows or not.protected org.apache.ecs.ElementgetHeadControls(String event, String order, String descorder) org.apache.ecs.Elementorg.apache.ecs.Elementorg.apache.ecs.ElementReturns the html code of the Columnorg.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 rowcharReturns the type of span for the label of the columnReturns thelayoutName, the name used for layout purpose such the dragging and dropping of the column for repositioningintGets the real min width value to apply.booleangetOrder()Gets the real order value to apply.booleanGets the real row in line value to apply.getStuck()Gets the stuck value of the columns.org.apache.ecs.html.TDReturns the TD cell elementorg.apache.ecs.html.TDReturns the TD cell elementorg.apache.ecs.html.TDReturns the TD cell elementGets the TD Colororg.apache.ecs.html.THintGets the maximum number of characters that are displayed in each column's cell.booleanReturns the boolean that defines if the column is hidden or not for the usercharGets the real vertical align value to apply.booleanDeprecated.intgetWidth()Gets the real width value to apply.protected booleanprotected booleanbooleanbooleanChecks if the column is draggable, ie if the user can change the positioning of the column with respect to the others in the table by dragging it.booleanChecks if the column will be present in the menu that appear when the user clicks on the icon in the upper left corner of the table and it can be used to rearrange the visibility and the position of the columns.booleanChecks the visibility of the Column, based on the set parameters (setVISIBLE(java.lang.String),setROVISIBLE(java.lang.String),setBLANKVISIBLE(java.lang.String)) and the status.protected booleanvoidSets the horizontal alignment of the values for every cell of the ColumnvoidDefines if the programmatically set background color of the column takes precedence over the color that defines the selectionvoidSets the column name used to define the background color of the cells of the column.voidDefines the coding of a value taken by the column (whose name corresponds to the one indicated in thebkgColorNameattribute (seesetBKGCOLORNAME())) in the corresponding color.voidSets the visibility of the Column when it blank state istruevoidDefines which are the characters on which the cell string value can be fragmented to be wrappedvoidsetConfiguredProperty(Map<String, Serializable> properties) Apply the user's properties customization into the component.voidSets if the column, by default, is visible to the user or not.voidDetermines if the column values (those that are currently stored in memory) can be sorted in descending order.voidDefines the name of the query used for sorting the values in descending order.voidvoidvoidvoidSets the footer values for the columnvoidDefines if equal values must be grouped in a single cellvoidDefines the name of a field (ie a Column of theDBView) that is used for grouping.voidsetHEADING(String s) Defines if the aspect of the column must be similar to the aspect of the column that contains the number of the rows.voidSets the string that appears as a tooltip when the user positions the cursor over the header of the ColumnvoidDefines whether the content of each cell of the column can be wrapped or notvoidDefines if the column will contains key values.voidSets the type of span for the label of the column.voidsetMINWIDTH(String minWidth) Sets the minimun width of the columnprotected voidsetMinWidthAndWidth(org.apache.ecs.html.TH th, String style) voidsetModelProperties(@NotNull DataAttribute dataAttribute) Sets the model properties based on the providedDataAttribute.voidDetermines if the column values (those that are currently stored in memory) can be sorted in ascending order.voidDefines aColumnOrderfor the columnvoidDefines the name of the query used for sorting the values in ascending order.voidSets the visibility of the Column when it readonly state istruevoidSets if the column is a stuck column or not.
To define the anchor on which the column will be fixed during the scroll, it is necessary to indicate whether the column should be anchored to the right "r" or to the left "l"voidSets a label associated to each column's cell value.voidSets theMapFormatwith which is created the tooltip that appears when the user positions the cursor over a cell of the ColumnvoidSets the name of the Column whose values, of the corresponding row, will be displayed within the tooltip that appears when the user positions the cursor over a cell of the Column.protected voidsetTooltipAndStyleOnLabel(org.apache.ecs.MultiPartElement el) voidDefines the maximum number of characters that are displayed in each column's cell.protected voidsetup()Setup the ComponentvoidsetupMetaData(DBView dbv) Called to init all the field starting form the DBViewprotected voidsetupTDColor(org.apache.ecs.html.TD td, EntitySet es, int row, ArrayList al) protected voidsetupTitle(org.apache.ecs.html.TD td, ArrayList al) voidsetUserHidden(boolean uh) Sets if the column is hidden or not for the uservoidSets the vertical alignment of the values for every cell of the ColumnvoidSets forcibly the valuevoidsetVISIBLE(String s) Defines if the column should be rendered or notvoidSets the width of the columnMethods 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
-
ALIGN_ATTRIBUTE
- See Also:
-
VERTICAL_ALIGN_ATTRIBUTE
- See Also:
-
WIDTH_ATTRIBUTE
- See Also:
-
STUCK_ATTRIBUTE
- See Also:
-
MIN_WIDTH_ATTRIBUTE
- See Also:
-
GROUP_ATTRIBUTE
- See Also:
-
TRUNCATE_ATTRIBUTE
- See Also:
-
ROW_IN_LINE_ATTRIBUTE
- See Also:
-
ORDER_ATTRIBUTE
- See Also:
-
ORDER_ASC_VALUE
- See Also:
-
ORDER_DESC_VALUE
- See Also:
-
ORDER_EITHER_VALUE
- See Also:
-
text
-
inline
protected boolean inline -
configuredRowInLine
-
_key
protected boolean _key -
_visible
-
_rovisible
-
_blankvisible
-
_align
protected char _align -
_valign
protected char _valign -
configuredAlign
-
configuredValign
-
_headTitle
-
_order
protected boolean _order -
_descorder
protected boolean _descorder -
configuredOrder
-
configuredDescOrder
-
_columnorder
-
_orderQuery
-
_descorderQuery
-
_errorvalue
-
_group
protected boolean _group -
configuredGroup
-
_groupname
-
_td
protected org.apache.ecs.html.TD _td -
_value
-
_rowspan
protected int _rowspan -
_groupObject
-
_tmColorSwitch
-
_bkgColorName
-
_bkgColorFirst
protected boolean _bkgColorFirst -
_colorIndex
protected int _colorIndex -
_labelspan
protected char _labelspan -
truncate
protected int truncate -
configuredTruncate
-
_width
protected int _width -
_minWidth
protected int _minWidth -
configuredWidth
-
configuredMinWidth
-
_tdColor
-
_stuck
Used to define if a column is a stuck column or not. -
configuredStuck
-
_heading
protected boolean _heading -
_breakChars
-
_msgErrore
-
_userHidden
protected boolean _userHidden -
_titleFormat
-
_draggable
-
_droppable
-
_ffName
-
_ffTitle
-
_ffGroup
-
-
Constructor Details
-
Column
public Column()
-
-
Method Details
-
setDRAGGABLE
-
setDROPPABLE
-
getDraggable
-
getDroppable
-
setUserHidden
public void setUserHidden(boolean uh) Sets if the column is hidden or not for the user- Parameters:
uh-trueto hide the column for the user,falseotherwise
-
getUserHidden
public boolean getUserHidden()Returns the boolean that defines if the column is hidden or not for the user- Returns:
trueif the column is hidden for the user,falseotherwise
-
isUserHideable
public boolean isUserHideable()Checks if the column will be present in the menu that appear when the user clicks on the icon in the upper left corner of the table and it can be used to rearrange the visibility and the position of the columns. The column is user hideable, and so it will appears in the menu, if it has a not null name (seeComponent.getNAME()) and label (seeControl.getLABEL()), if it is visible (seeisVisible()) and has labelspan attribute set to 'n' (seesetLABELSPAN(java.lang.String)).- Returns:
trueif the column is user hideable and will appear in the menu,falseotherwise
-
isUserDraggable
public boolean isUserDraggable()Checks if the column is draggable, ie if the user can change the positioning of the column with respect to the others in the table by dragging it. The column is draggable if is hideable (seeisUserHideable()) and has a label (seeControl.getLABEL()) that is not an empty string.- Returns:
trueif the user can drag the column to change its position,falseotherwise
-
getAlign
public char getAlign()Gets the real align value to apply.
This method returns the value of the attribute based on if there is a user customization on the align attribute. If there is no customization returns the default value.- Returns:
- 'c' to obtain the values aligned in the center of the column, 'l' to obtain the values aligned to the left, 'r' to obtain the values aligned to the right
-
getVAlign
public char getVAlign()Gets the real vertical align value to apply.
This method returns the value of the attribute based on if there is a user customization on the vertical align attribute. If there is no customization returns the default value.- Returns:
- 'c' to obtain the values vertically aligned at the center of the cell, 't to obtain the values aligned to the top, 'b' to obtain the values aligned to the bottom
-
getWidth
public int getWidth()Gets the real width value to apply.
This method returns the value of the attribute based on if there is a user customization on the width attribute. If there is no customization returns the default value.- Returns:
- the real width value to apply
-
getMinWidth
public int getMinWidth()Gets the real min width value to apply.
This method returns the value of the attribute based on if there is a user customization on the min width attribute. If there is no customization returns the default value.- Returns:
- the real min width value to apply
-
getTruncate
public int getTruncate()Gets the maximum number of characters that are displayed in each column's cell. The strings are then limited to that number of characters and to indicate the fact that the information is not complete, the three points of suspension are added.
This method returns the value of the attribute based on if there is a user customization on the truncate attribute. If there is no customization returns the default value.- Returns:
- the real truncate value to apply
-
getGroup
public boolean getGroup()Gets if the column is set to grouping its rows or not. This method returns the value of the attribute based on if there is a user customization on the group attribute. If there is no customization returns the default value.- Returns:
trueif the column is set to grouping its rows,falseotherwise.
-
getRowInLine
public boolean getRowInLine()Gets the real row in line value to apply.
This method returns the value of the attribute based on if there is a user customization on the row in line attribute. If there is no customization returns the default value.- Returns:
- the real row in line value to apply
-
getOrder
public boolean getOrder()Gets the real order value to apply.
This method returns the value of the attribute based on if there is a user customization on the order attribute. If there is no customization returns the default value.- Returns:
- the real order value to apply
-
getDescOrder
public boolean getDescOrder()Gets the real desc order value to apply.
This method returns the value of the attribute based on if there is a user customization on the desc order attribute. If there is no customization returns the default value.- Returns:
- the real desc order value to apply
-
setup
protected void setup()Description copied from class:ComponentSetup the Component -
setVALUE
Sets forcibly the value- Parameters:
s- The value to set
-
setVISIBLE
Defines if the column should be rendered or not- Specified by:
setVISIBLEin interfaceHideable- Parameters:
s- A string that represent a boolean value ("true" or "1", "false" or "0") or a function.
If the string is not recognized as a boolean value, it is considered as a user function with this meaning: if the user currently logged in the application has the function, the form will be rendered, otherwise it will not
-
getVISIBLE
public boolean getVISIBLE()Deprecated.UseisVisible()instead- Specified by:
getVISIBLEin interfaceHideable- Returns:
- Use
isVisible()instead
-
setROVISIBLE
Sets the visibility of the Column when it readonly state istrue- Parameters:
s-trueif the Column will be visible when read only,falseotherwise, or a name of a function used to determine visibility (seeisVisible())
-
setBLANKVISIBLE
Sets the visibility of the Column when it blank state istrue- Parameters:
s-trueif the Column will be visible when in blank state,falseotherwise, or a name of a function used to determine visibility (seeisVisible())
-
setDEFAULTHIDDEN
Sets if the column, by default, is visible to the user or not.- Overrides:
setDEFAULTHIDDENin classComponent- Parameters:
s-trueif the column is visible for the user orfalseotherwise.
-
setTITLEFORMAT
Sets theMapFormatwith which is created the tooltip that appears when the user positions the cursor over a cell of the Column- Parameters:
s- The string used as aMapFormatto create the tooltip
-
isVisible
public boolean isVisible()Checks the visibility of the Column, based on the set parameters (setVISIBLE(java.lang.String),setROVISIBLE(java.lang.String),setBLANKVISIBLE(java.lang.String)) and the status. SeegetBoolean(visible,id,true)) -
setALIGN
Sets the horizontal alignment of the values for every cell of the Column- Parameters:
s- "center" or "c" to obtain the values aligned in the center of the column, "left" or "l" to obtain the values aligned to the left, "right" or "r" to obtain the values aligned to the right
-
setVALIGN
Sets the vertical alignment of the values for every cell of the Column- Parameters:
s- "center" or "c" to obtain the values vertically aligned at the center of the cell, "top" or "t" to obtain the values aligned to the top, "bottom" or "b" to obtain the values aligned to the bottom
-
setHEADTITLE
Sets the string that appears as a tooltip when the user positions the cursor over the header of the Column- Parameters:
s- The string used as tooltip for the column's header
-
setTITLENAME
Sets the name of the Column whose values, of the corresponding row, will be displayed within the tooltip that appears when the user positions the cursor over a cell of the Column. In this way we can, for example, show in the tooltip the values of a not visible column.
This attribute prevails respect the one set withsetTITLEFORMAT(java.lang.String)- Parameters:
s- The name of a Column
-
setERRORVALUE
Sets the value displayed in the column cells when there is an error; for example when in theDBViewset to theTableView) to which the column belongs there isn't a field that corresponds to the column's name. In these cases, by default, a standard error message is displayed to the developer.- Parameters:
s- The error value to display
-
setORDER
Determines if the column values (those that are currently stored in memory) can be sorted in ascending order. Setting this attribute totrue, a clickable icon will appear next to the column heading label, clicking on which the data will be sorted.- Parameters:
s-trueto allows the ascending order,falseotherwise
-
setDESCORDER
Determines if the column values (those that are currently stored in memory) can be sorted in descending order. Setting this attribute totrue, a clickable icon will appear next to the column heading label, clicking on which the data will be sorted.- Parameters:
s-trueto allows the descending order,falseotherwise
-
setORDERFIELD
Defines aColumnOrderfor the column- Parameters:
s- A string that defines aColumnOrderfor the column
-
setORDERQUERY
Defines the name of the query used for sorting the values in ascending order. SeeDABaseandServerTableView- Parameters:
s- The string that defines the name of the query used for sorting
-
setDESCORDERQUERY
Defines the name of the query used for sorting the values in descending order. SeeDABaseandServerTableView- Parameters:
s- The string that defines the name of the query used for sorting
-
setLABELSPAN
Sets the type of span for the label of the column.- Parameters:
s- "none" or "n" means no span; "left" or "l" means that the column label on the left (ie the label of the column positioned just before this one) will expand to cover the heading of this column too; "right" or "r" means that the label of this column will expand to cover the heading of the label on the right, ie the column positioned just after this one.
-
getLABELSPAN
public char getLABELSPAN()Returns the type of span for the label of the column- Returns:
- One of "n", "l" or "r". See
setLABELSPAN(java.lang.String)
-
setTRUNCATE
Defines the maximum number of characters that are displayed in each column's cell. The strings are then limited to that number of characters and to indicate the fact that the information is not complete, the three points of suspension are added.- Parameters:
s- The maximum number of characters displayed for the column
-
setKEY
Defines if the column will contains key values.
At each key column is assigned a particular CSS style that makes it more evident; the style is based on the specific theme currently used.- 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
-
setINLINE
Defines whether the content of each cell of the column can be wrapped or not- 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
-
setTEXT
Sets a label associated to each column's cell value. Used byColumnButtonandColumnBoolean- Parameters:
s- A label associated to each cell
-
setGROUP
Defines if equal values must be grouped in a single cell- 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
-
setGROUPNAME
Defines the name of a field (ie a Column of theDBView) that is used for grouping.- Parameters:
s- A string that represents the name of a field
-
setBKGCOLORNAME
Sets the column name used to define the background color of the cells of the column.
If it is not defined a value for thebkgColorSwitchattribute (seesetBKGCOLORSWITCH()), the background color of the column is defined by the value contained in the column set as parameter (the value must be compliant to css color rules). Otherwise the color is defined based on the decoding of the value of thebkgColorSwitchattribute- Parameters:
s- The name of the column used to select the background color
-
setBKGCOLORSWITCH
Defines the coding of a value taken by the column (whose name corresponds to the one indicated in thebkgColorNameattribute (seesetBKGCOLORNAME())) in the corresponding color.- Parameters:
s- The parameter must be compliant to this format: "value,color,value,color,..." where value is a possible value of the field, and color is the corresponding color. Here are some usage examples:
"1,#FF0000,2,#00FF002": if the value of the field defined inbkgColorNameis equals to 1, then the background color will be #FF0000. Otherwise if it's equals to 2, then the color will be #00FF00
"1,red,,blue": if the value of the field defined inbkgColorNameis equals to 1, then the background color will be red, otherwise will be blue
"1,red,0,": if the value of the field defined inbkgColorNameis equals to 1, then the background color will be red, otherwise if it's 0, no color will be applied
-
setBKGCOLORFIRST
Defines if the programmatically set background color of the column takes precedence over the color that defines the selection- 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 true
-
setBREAKCHARS
Defines which are the characters on which the cell string value can be fragmented to be wrapped- Parameters:
s- A string in which each character establishes a possible point where the cell string value can be fragmented
-
setFOOTER
Sets the footer values for the column- Parameters:
s- The footer values
-
setHEADING
Defines if the aspect of the column must be similar to the aspect of the column that contains the number of the rows. The specific aspect (background, color, etc.) depends on the theme used.- 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
-
setWIDTH
Sets the width of the column- Parameters:
width- The width of the column
-
setSTUCK
Sets if the column is a stuck column or not.
To define the anchor on which the column will be fixed during the scroll, it is necessary to indicate whether the column should be anchored to the right "r" or to the left "l"- Parameters:
s- Possible value are "l" as left, "r" as right.
-
getStuck
Gets the stuck value of the columns. If it's null the column isn't a stuck column.- Returns:
- "l" if the column is stuck and is anchored to the left, "r" if the column is stuck and is anchored to the right, null otherwise.
-
setMINWIDTH
Sets the minimun width of the column- Parameters:
minWidth- The minimun width of the column
-
getTF
-
getHtmlFoot
Returns the footer values of the column- Parameters:
footValues- TheHashGetterthat contains the values- Returns:
- The footer values of the column
-
getColumnOrder
Returns theColumnOrderof the column- Returns:
- The ColumnOrder element of the column
-
getHeadLabel
-
getDefaultLayoutLabel
- Overrides:
getDefaultLayoutLabelin classComponent
-
getHeadControls
-
getHeadControls
-
getHtml
Returns the html code of the Column -
setTooltipAndStyleOnLabel
protected void setTooltipAndStyleOnLabel(org.apache.ecs.MultiPartElement el) -
setMinWidthAndWidth
-
setupMetaData
Called to init all the field starting form the DBView- Parameters:
dbv- The DBView with all the field used in the init
-
freeResources
public void freeResources() -
getTD
Returns the TD cell element- Parameters:
es- TheEntitySetto which the element belongsrow- The number of the rowal- The list of values of the row- Returns:
- The TD cell element
-
getTD
Returns the TD cell element- Parameters:
es- TheEntitySetto which the element belongsrow- The number of the rowal- The list of values of the rowroll-trueif the mouse cursor is positioned over the cell,falseotherwise- Returns:
- The TD cell element
-
getTD
public org.apache.ecs.html.TD getTD(EntitySet es, int row, ArrayList al, boolean roll, boolean selected) Returns the TD cell element- Parameters:
es- TheEntitySetto which the element belongsrow- The number of the rowal- The list of values of the rowroll-trueif the mouse cursor is positioned over the cell,falseotherwiseselected-trueif the row is currently selected,falseotherwise- Returns:
- The TD cell element
-
setupTitle
-
setupTDColor
-
getTDColor
Gets the TD Color- Returns:
- The string with the TD Color
-
groupable
protected boolean groupable() -
grouped
-
newGroup
-
getHtmlRow
Returns the html element that defines the row- 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
-
getCellContent
-
setConfiguredProperty
Description copied from interface:overit.geocall.ux.configurability.UIConfigurableApply the user's properties customization into the component.- Specified by:
setConfiguredPropertyin interfaceoverit.geocall.ux.configurability.UIConfigurable- Overrides:
setConfiguredPropertyin classControl- Parameters:
properties- The map containing the configured properties to set
-
getConfigurableProperties
Description copied from interface:overit.geocall.ux.configurability.UIConfigurableGets a set ofUIPropertyobject that represents the configurable UI properties that the object can handle.
EachUIPropertyobject, can be used to retrieve some information about the configurable property, for example it can be used to design the ui xml objects to inject into the properties configurability section of the ResponsiveGrids and TableVies configurability panels.
The property section are those section placed on the left side of the panel and shown when user click on the settings icon of a field to customize its properties.- Specified by:
getConfigurablePropertiesin interfaceoverit.geocall.ux.configurability.UIConfigurable- Overrides:
getConfigurablePropertiesin classControl- Returns:
- object that represents the configurable UI properties that the object can handle.
-
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 classControl- Parameters:
dataAttribute- a non-nullDataAttributeused to set model properties
-
isHiddenByConfiguration
public boolean isHiddenByConfiguration() -
getLayoutName
Description copied from class:ComponentReturns thelayoutName, the name used for layout purpose such the dragging and dropping of the column for repositioning- Overrides:
getLayoutNamein classComponent- Returns:
- The string that corresponds to the
layoutNameof the column
-
isVisible()instead