Class ColumnDescriptor


  • public class ColumnDescriptor
    extends java.lang.Object
    A ColumnDescriptor specifies what module attribute to show in a column of the modules view, how to format it,

    and what the column's label should be.

    It is only used if the underlying UI actually supports this level of customization.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAttributeName()
      Name of the attribute rendered in this column.
      java.lang.String getFormat()
      Format to use for the rendered values in this column.
      java.lang.String getLabel()
      Header UI label of column.
      ColumnDescriptorType getType()
      Datatype of values in this column.
      java.lang.Integer getWidth()
      Width of this column in characters (hint only).
      int hashCode()  
      void setAttributeName​(java.lang.String attributeName)
      Name of the attribute rendered in this column.
      void setFormat​(java.lang.String format)
      Format to use for the rendered values in this column.
      void setLabel​(java.lang.String label)
      Header UI label of column.
      void setType​(ColumnDescriptorType type)
      Datatype of values in this column.
      void setWidth​(java.lang.Integer width)
      Width of this column in characters (hint only).
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ColumnDescriptor

        public ColumnDescriptor()
    • Method Detail

      • getAttributeName

        public java.lang.String getAttributeName()
        Name of the attribute rendered in this column.
      • setAttributeName

        public void setAttributeName​(java.lang.String attributeName)
        Name of the attribute rendered in this column.
      • getLabel

        public java.lang.String getLabel()
        Header UI label of column.
      • setLabel

        public void setLabel​(java.lang.String label)
        Header UI label of column.
      • getFormat

        public java.lang.String getFormat()
        Format to use for the rendered values in this column. TBD how the format strings looks like.

        This is an optional property.

      • setFormat

        public void setFormat​(java.lang.String format)
        Format to use for the rendered values in this column. TBD how the format strings looks like.

        This is an optional property.

      • getType

        public ColumnDescriptorType getType()
        Datatype of values in this column. Defaults to 'string' if not specified.

        This is an optional property.

      • setType

        public void setType​(ColumnDescriptorType type)
        Datatype of values in this column. Defaults to 'string' if not specified.

        This is an optional property.

      • getWidth

        public java.lang.Integer getWidth()
        Width of this column in characters (hint only).

        This is an optional property.

      • setWidth

        public void setWidth​(java.lang.Integer width)
        Width of this column in characters (hint only).

        This is an optional property.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object