Class 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

@Component @Configurable @Ignore("TRUNCATE") public class ColumnDTZ extends Column
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
  • Field Details

  • Constructor Details

    • ColumnDTZ

      public ColumnDTZ()
  • Method Details

    • setCOMPONENTS

      public void setCOMPONENTS(String s)
      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 order of the characters in the string is not deterministic.
      The default component is date.
    • isComponentDateActive

      public boolean isComponentDateActive()
      Gets if the date component is active or not.
      Returns:
      true if the date component is active, false otherwise.
    • isComponentTimeActive

      public boolean isComponentTimeActive()
      Gets if the time component is active or not.
      Returns:
      true if the time component is active, false otherwise.
    • setZONENAME

      public void setZONENAME(String zonename)
      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

      public void setZONEVALUE(String zonevalue)
      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

      public void setRANGE(String s)
      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 to DATE_MIN
      • "DATE_TO": set the end of the date range. If the date isn't set, it is automatically set to DATE_MAX
      • "TIME_FROM": set the start of the time range. If the time isn't set, it is automatically set to TIME_MIN
      • "TIME_TO": set the end of the time range. If the time isn't set, it is automatically set to TIME_MAX
      • "FULL": set the range as date and hour passed.
    • setSDFD

      public void setSDFD(String s)
      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 (see SimpleDateFormat). 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

      public void setSDFT(String s)
      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 (see SimpleDateFormat). If it isn't set the default value is ""HH:mm"".
      Parameters:
      s - The string of the time format.
    • setPREFIX

      public void setPREFIX(String s)
      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: Component
      Setup the Component
      Overrides:
      setup in class Column
    • setupMetaData

      public void setupMetaData(DBView dbv)
      Description copied from class: Column
      Called to init all the field starting form the DBView
      Overrides:
      setupMetaData in class Column
      Parameters:
      dbv - The DBView with all the field used in the init
    • getHtmlRow

      public org.apache.ecs.Element getHtmlRow(EntitySet es, int row, int pagerow, ArrayList al)
      Description copied from class: Column
      Returns the html element that defines the row
      Overrides:
      getHtmlRow in class Column
      Parameters:
      es - The EntitySet to which the element belongs
      row - The number of the row
      pagerow - The number ofd the page
      al - The list of values of the row
      Returns:
      The html element that defines the row
    • getHtmlFoot

      public org.apache.ecs.Element getHtmlFoot(HashGetter footValues)
      Description copied from class: Column
      Returns the footer values of the column
      Overrides:
      getHtmlFoot in class Column
      Parameters:
      footValues - The HashGetter that contains the values
      Returns:
      The footer values of the column
    • prepareValue

      protected String prepareValue(Date d, TimeZone tz)
    • setModelProperties

      public void setModelProperties(@NotNull @NotNull DataAttribute dataAttribute)
      Description copied from interface: overit.geocall.ux.edm.ModelConfigurable
      Sets the model properties based on the provided DataAttribute.
      Specified by:
      setModelProperties in interface overit.geocall.ux.edm.ModelConfigurable
      Overrides:
      setModelProperties in class Column
      Parameters:
      dataAttribute - a non-null DataAttribute used to set model properties
    • getDefaultLayoutLabel

      public String getDefaultLayoutLabel()
      Overrides:
      getDefaultLayoutLabel in class Column