Module org.tentackle.fx
Package org.tentackle.fx.table

Interface TableColumnConfiguration<S,​T>

  • Type Parameters:
    S - type of the objects contained within the table's items list
    T - type of the content in all cells in this column
    All Known Implementing Classes:
    DefaultTableColumnConfiguration
    public interface TableColumnConfiguration<S,​T>
    Configuration for a table column.
    Author:
    harald

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      javafx.geometry.Pos getAlignment()
      Defines the alignment of the column.
      FxTableBinding<S,​T> getBinding()
      Gets the binding for this column.
      java.lang.Boolean getCaseConversion()
      Gets the case conversion.
      java.text.DateFormat getDateFormat()
      Gets the date format.
      java.time.format.DateTimeFormatter getDateTimeFormatter()
      Gets the date or time formatter.
      java.lang.String getDisplayedName()
      Gets the column name displayed in the column header.
      java.lang.Boolean getEditable()
      Returns whether the column is editable.
      FxComponent getEditor()
      Gets the editor component.
      java.lang.reflect.Type getGenericType()
      Gets the generic type.
      java.lang.String getInvalidChars()
      Gets invalid characters.
      java.lang.Integer getMaxColumns()
      Gets the maximum columns for text cell editors.
      java.lang.String getName()
      Gets the column name.
      This is usually the binding path.
      The name is also used as a key to the table preferences.
      java.text.DecimalFormat getNumberFormat()
      Gets the number format.
      java.lang.String getPattern()
      Defines the format for numeric or date/time-types.
      If null is returned a default format will be used according to the column class.
      java.lang.Integer getScale()
      Gets the scale for fractional numeric cell editors.
      java.lang.Boolean getSummable()
      Returns whether the column is summable.
      javafx.scene.control.TableColumn<S,​T> getTableColumn()
      Gets the table column.
      TableConfiguration<S> getTableConfiguration()
      Gets the table configuration.
      java.lang.Class<T> getType()
      Determines the class for a given column.
      java.lang.String getValidChars()
      Gets allowed characters.
      java.lang.Boolean isAutoSelect()
      Gets the autoselect flag.
      java.lang.Boolean isBlankZero()
      Defines the "blankzero" attribute of the column.
      boolean isEditable()
      Returns whether column is editable.
      boolean isSummable()
      Determines whether the column is summable.
      java.lang.Boolean isUnsigned()
      Returns whether a numeric field is unsigned or signed.
      void setAlignment​(javafx.geometry.Pos alignment)
      Sets the alignment within the cell.
      void setAutoSelect​(java.lang.Boolean autoSelect)
      Sets the autoselect feature.
      void setBinding​(FxTableBinding<S,​T> binding)
      Sets the binding.
      void setBlankZero​(java.lang.Boolean blankZero)
      Sets whether to blank out numeric zero values.
      void setCaseConversion​(java.lang.Boolean caseConversion)
      Sets the case conversion.
      void setDisplayedName​(java.lang.String displayName)
      Sets the column name displayed in the column header.
      void setEditable​(java.lang.Boolean editable)
      Sets whether the column is editable.
      void setEditor​(FxComponent editor)
      Sets the editor component.
      void setGenericType​(java.lang.reflect.Type genericType)
      Sets the generic type.
      void setInvalidChars​(java.lang.String invalidChars)
      Sets invalid characters.
      void setMaxColumns​(java.lang.Integer maxColumns)
      Sets the max columns.
      void setPattern​(java.lang.String pattern)
      Sets the formatting string.
      void setScale​(java.lang.Integer scale)
      Sets the numeric scale.
      void setSummable​(java.lang.Boolean summable)
      Sets whether the column is summable.
      void setType​(java.lang.Class<T> type)
      Sets the column type.
      void setUnsigned​(java.lang.Boolean unsigned)
      Sets whether a numeric field is unsigned or signed.
      void setValidChars​(java.lang.String validChars)
      Sets allowed characters.

    • Method Detail

      • getTableConfiguration

        TableConfiguration<S> getTableConfiguration()
        Gets the table configuration.
        Returns:
        the table configuration

      • getName

        java.lang.String getName()
        Gets the column name.
        This is usually the binding path.
        The name is also used as a key to the table preferences.
        Returns:
        the name of the column

      • getDisplayedName

        java.lang.String getDisplayedName()
        Gets the column name displayed in the column header.
        Returns:
        the display name of the column

      • setDisplayedName

        void setDisplayedName​(java.lang.String displayName)
        Sets the column name displayed in the column header.
        Parameters:
        displayName - the display name of the column

      • getType

        java.lang.Class<T> getType()
        Determines the class for a given column.
        Returns:
        the column class

      • setType

        void setType​(java.lang.Class<T> type)
        Sets the column type.
        Parameters:
        type - the type

      • setGenericType

        void setGenericType​(java.lang.reflect.Type genericType)
        Sets the generic type.
        Parameters:
        genericType - the generic type

      • getGenericType

        java.lang.reflect.Type getGenericType()
        Gets the generic type.
        Returns:
        the generic type

      • getPattern

        java.lang.String getPattern()
        Defines the format for numeric or date/time-types.
        If null is returned a default format will be used according to the column class.
        Returns:
        the format pattern or null if default

      • setPattern

        void setPattern​(java.lang.String pattern)
        Sets the formatting string.
        Parameters:
        pattern - the format pattern

      • getNumberFormat

        java.text.DecimalFormat getNumberFormat()
        Gets the number format.
        Returns:
        the number format, null if default

      • getDateFormat

        java.text.DateFormat getDateFormat()
        Gets the date format.
        Returns:
        the date format, null if default

      • getDateTimeFormatter

        java.time.format.DateTimeFormatter getDateTimeFormatter()
        Gets the date or time formatter.
        Returns:
        the formatter, null if default

      • getAlignment

        javafx.geometry.Pos getAlignment()
        Defines the alignment of the column.
        Returns:
        the alignment or null if default

      • setAlignment

        void setAlignment​(javafx.geometry.Pos alignment)
        Sets the alignment within the cell.
        Parameters:
        alignment - the alignment

      • isBlankZero

        java.lang.Boolean isBlankZero()
        Defines the "blankzero" attribute of the column.
        Returns:
        true if blank zeros, false if not, null if use default from editor

      • setBlankZero

        void setBlankZero​(java.lang.Boolean blankZero)
        Sets whether to blank out numeric zero values.
        Parameters:
        blankZero - true if blank zeros, false if not, null if use default from editor

      • setUnsigned

        void setUnsigned​(java.lang.Boolean unsigned)
        Sets whether a numeric field is unsigned or signed.
        Parameters:
        unsigned - true if unsigned, null if use default from editor

      • isUnsigned

        java.lang.Boolean isUnsigned()
        Returns whether a numeric field is unsigned or signed.
        Returns:
        true if unsigned, null if use default from editor

      • setValidChars

        void setValidChars​(java.lang.String validChars)
        Sets allowed characters.
        Parameters:
        validChars - the valid characters, null if use default from editor

      • getValidChars

        java.lang.String getValidChars()
        Gets allowed characters.
        Returns:
        the valid characters, null if use default from editor

      • setInvalidChars

        void setInvalidChars​(java.lang.String invalidChars)
        Sets invalid characters.
        Parameters:
        invalidChars - the invalid characters, null if use default from editor

      • getInvalidChars

        java.lang.String getInvalidChars()
        Gets invalid characters.
        Returns:
        the invalid characters, null if use default from editor

      • isAutoSelect

        java.lang.Boolean isAutoSelect()
        Gets the autoselect flag.
        Returns:
        true if autoselect, false if not, null if use default from editor

      • setAutoSelect

        void setAutoSelect​(java.lang.Boolean autoSelect)
        Sets the autoselect feature.
        Parameters:
        autoSelect - true if autoselect, false if not, null if use default from editor

      • getMaxColumns

        java.lang.Integer getMaxColumns()
        Gets the maximum columns for text cell editors.
        Returns:
        the max columns, null if not defined

      • setMaxColumns

        void setMaxColumns​(java.lang.Integer maxColumns)
        Sets the max columns.
        Parameters:
        maxColumns - the max columns, null if not defined

      • getScale

        java.lang.Integer getScale()
        Gets the scale for fractional numeric cell editors.
        Returns:
        the scale, null if not defined

      • setScale

        void setScale​(java.lang.Integer scale)
        Sets the numeric scale.
        Parameters:
        scale - the scale, null if not defined

      • getCaseConversion

        java.lang.Boolean getCaseConversion()
        Gets the case conversion.
        Returns:
        true = convert to uppercase, false = lowercase, null = no conversion (default)

      • setCaseConversion

        void setCaseConversion​(java.lang.Boolean caseConversion)
        Sets the case conversion.
        Parameters:
        caseConversion - true = convert to uppercase, false = lowercase, null = no conversion (default)

      • isSummable

        boolean isSummable()
        Determines whether the column is summable.
        Returns:
        true if column is summable

      • setSummable

        void setSummable​(java.lang.Boolean summable)
        Sets whether the column is summable.
        Parameters:
        summable - Boolean.TRUE if summable, Boolean.FALSE if not, NULL if numeric type

      • getSummable

        java.lang.Boolean getSummable()
        Returns whether the column is summable.
        Returns:
        Boolean.TRUE if summable, Boolean.FALSE if not, NULL if numeric type

      • getEditable

        java.lang.Boolean getEditable()
        Returns whether the column is editable.
        Returns:
        Boolean.TRUE if editable, Boolean.FALSE if not, NULL if depends on table configuration

      • setEditable

        void setEditable​(java.lang.Boolean editable)
        Sets whether the column is editable.
        Parameters:
        editable - Boolean.TRUE if editable, Boolean.FALSE if not, NULL if depends on table configuration

      • isEditable

        boolean isEditable()
        Returns whether column is editable.
        Returns:
        true if editable, the default is false

      • getBinding

        FxTableBinding<S,​T> getBinding()
        Gets the binding for this column.
        Returns:
        the binding, null if none

      • setBinding

        void setBinding​(FxTableBinding<S,​T> binding)
        Sets the binding.
        Parameters:
        binding - the binding

      • getTableColumn

        javafx.scene.control.TableColumn<S,​T> getTableColumn()
        Gets the table column.
        Returns:
        the table column, never null