Class GridTableColumn<S,T>

java.lang.Object
javafx.scene.layout.ConstraintsBase
javafx.scene.layout.ColumnConstraints
com.dlsc.gemsfx.gridtable.GridTableColumn<S,T>
Type Parameters:
S - table item type
T - table cell value type
public class GridTableColumn<S,T> extends javafx.scene.layout.ColumnConstraints
A column in a GridTableView.

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<GridTableView<S>, GridTableCell<S,T>>>
    cellFactory
    Stores the factory used to create cells for this column.
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<S,T>>
    cellValueFactory
    Stores the factory used to extract cell values from row items.
    final javafx.beans.property.ObjectProperty<javafx.scene.control.ContentDisplay>
    contentDisplay
    Stores how the text and graphic should be arranged in the header.
    final javafx.beans.property.ObjectProperty<javafx.util.StringConverter<T>>
    converter
    Stores the converter used to turn cell values into text.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    graphic
    Stores the graphic shown in the header.
    final javafx.beans.property.ReadOnlyObjectProperty<javafx.scene.Node>
    header
    A read-only property containing the header node.
    final javafx.beans.property.StringProperty
    text
    Stores the text shown in the header.

    Properties inherited from class javafx.scene.layout.ColumnConstraints

    fillWidth, halignment, hgrow, maxWidth, minWidth, percentWidth, prefWidth

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    javafx.beans.property.ObjectProperty<javafx.util.Callback<S,T>>
    cellValueFactory
     

    Fields inherited from class javafx.scene.layout.ConstraintsBase

    CONSTRAIN_TO_PREF

  • Constructor Summary

    Constructors
    Constructor
    Description
    GridTableColumn()
    Constructs a new grid table column with an empty header.
    GridTableColumn(String text)
    Constructs a new grid table column that only shows text.
    GridTableColumn(String text, javafx.scene.Node graphic)
    Constructs a new grid table column.
    GridTableColumn(javafx.scene.Node graphic)
    Constructs a new grid table column that only shows a graphic.

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<GridTableView<S>, GridTableCell<S,T>>>
    cellFactoryProperty()
    Stores the factory used to create cells for this column.
    final javafx.beans.property.ObjectProperty<javafx.util.Callback<S,T>>
    cellValueFactoryProperty()
    Stores the factory used to extract cell values from row items.
    final javafx.beans.property.ObjectProperty<javafx.scene.control.ContentDisplay>
    contentDisplayProperty()
    Stores how the text and graphic should be arranged in the header.
    final javafx.beans.property.ObjectProperty<javafx.util.StringConverter<T>>
    converterProperty()
    Stores the converter used to turn cell values into text.
    final GridTableCell<S,T>
    createCell(GridTableView<S> tableView, int index)
    Creates a new cell for the given table view and row index.
    final javafx.util.Callback<GridTableView<S>, GridTableCell<S,T>>
    getCellFactory()
    Gets the value of the cellFactory property.
    final javafx.util.Callback<S,T>
    getCellValueFactory()
    Gets the value of the cellValueFactory property.
    final javafx.scene.control.ContentDisplay
    getContentDisplay()
    Gets the value of the contentDisplay property.
    final javafx.util.StringConverter<T>
    getConverter()
    Gets the value of the converter property.
    final javafx.scene.Node
    getGraphic()
    Gets the value of the graphic property.
    final javafx.scene.Node
    getHeader()
    Gets the value of the header property.
    javafx.collections.ObservableList<String>
    getStyleClass()
    Returns the style classes applied to cells created by this column.
    final String
    getText()
    Gets the value of the text property.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    graphicProperty()
    Stores the graphic shown in the header.
    final javafx.beans.property.ReadOnlyObjectProperty<javafx.scene.Node>
    headerProperty()
    A read-only property containing the header node.
    final void
    setCellFactory(javafx.util.Callback<GridTableView<S>, GridTableCell<S,T>> cellFactory)
    Sets the value of the cellFactory property.
    final void
    setCellValueFactory(javafx.util.Callback<S,T> cellValueFactory)
    Sets the value of the cellValueFactory property.
    final void
    setContentDisplay(javafx.scene.control.ContentDisplay contentDisplay)
    Sets the value of the contentDisplay property.
    final void
    setConverter(javafx.util.StringConverter<T> converter)
    Sets the value of the converter property.
    final void
    setGraphic(javafx.scene.Node graphic)
    Sets the value of the graphic property.
    final void
    setText(String text)
    Sets the value of the text property.
    final javafx.beans.property.StringProperty
    textProperty()
    Stores the text shown in the header.

    Methods inherited from class javafx.scene.layout.ColumnConstraints

    fillWidthProperty, getHalignment, getHgrow, getMaxWidth, getMinWidth, getPercentWidth, getPrefWidth, halignmentProperty, hgrowProperty, isFillWidth, maxWidthProperty, minWidthProperty, percentWidthProperty, prefWidthProperty, setFillWidth, setHalignment, setHgrow, setMaxWidth, setMinWidth, setPercentWidth, setPrefWidth, toString

    Methods inherited from class javafx.scene.layout.ConstraintsBase

    requestLayout

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Property Details

  • Field Details

    • cellValueFactory

      public javafx.beans.property.ObjectProperty<javafx.util.Callback<S,T>> cellValueFactory

  • Constructor Details

    • GridTableColumn

      public GridTableColumn(String text, javafx.scene.Node graphic)
      Constructs a new grid table column.
      Parameters:
      text - the column text
      graphic - the column graphic

    • GridTableColumn

      public GridTableColumn(javafx.scene.Node graphic)
      Constructs a new grid table column that only shows a graphic.
      Parameters:
      graphic - the column graphic

    • GridTableColumn

      public GridTableColumn(String text)
      Constructs a new grid table column that only shows text.
      Parameters:
      text - the column text

    • GridTableColumn

      public GridTableColumn()
      Constructs a new grid table column with an empty header.

  • Method Details

    • getStyleClass

      public javafx.collections.ObservableList<String> getStyleClass()
      Returns the style classes applied to cells created by this column.
      Returns:
      the style classes

    • getContentDisplay

      public final javafx.scene.control.ContentDisplay getContentDisplay()
      Gets the value of the contentDisplay property.
      Property description:
      Stores how the text and graphic should be arranged in the header.
      Returns:
      the value of the contentDisplay property
      See Also:

    • contentDisplayProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.control.ContentDisplay> contentDisplayProperty()
      Stores how the text and graphic should be arranged in the header.
      Returns:
      the content display property
      See Also:

    • setContentDisplay

      public final void setContentDisplay(javafx.scene.control.ContentDisplay contentDisplay)
      Sets the value of the contentDisplay property.
      Property description:
      Stores how the text and graphic should be arranged in the header.
      Parameters:
      contentDisplay - the value for the contentDisplay property
      See Also:

    • getGraphic

      public final javafx.scene.Node getGraphic()
      Gets the value of the graphic property.
      Property description:
      Stores the graphic shown in the header.
      Returns:
      the value of the graphic property
      See Also:

    • graphicProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicProperty()
      Stores the graphic shown in the header.
      Returns:
      the graphic property
      See Also:

    • setGraphic

      public final void setGraphic(javafx.scene.Node graphic)
      Sets the value of the graphic property.
      Property description:
      Stores the graphic shown in the header.
      Parameters:
      graphic - the value for the graphic property
      See Also:

    • getText

      public final String getText()
      Gets the value of the text property.
      Property description:
      Stores the text shown in the header.
      Returns:
      the value of the text property
      See Also:

    • textProperty

      public final javafx.beans.property.StringProperty textProperty()
      Stores the text shown in the header.
      Returns:
      the text property
      See Also:

    • setText

      public final void setText(String text)
      Sets the value of the text property.
      Property description:
      Stores the text shown in the header.
      Parameters:
      text - the value for the text property
      See Also:

    • getConverter

      public final javafx.util.StringConverter<T> getConverter()
      Gets the value of the converter property.
      Property description:
      Stores the converter used to turn cell values into text.
      Returns:
      the value of the converter property
      See Also:

    • converterProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.StringConverter<T>> converterProperty()
      Stores the converter used to turn cell values into text.
      Returns:
      the converter property
      See Also:

    • setConverter

      public final void setConverter(javafx.util.StringConverter<T> converter)
      Sets the value of the converter property.
      Property description:
      Stores the converter used to turn cell values into text.
      Parameters:
      converter - the value for the converter property
      See Also:

    • getCellFactory

      public final javafx.util.Callback<GridTableView<S>, GridTableCell<S,T>> getCellFactory()
      Gets the value of the cellFactory property.
      Property description:
      Stores the factory used to create cells for this column.
      Returns:
      the value of the cellFactory property
      See Also:

    • cellFactoryProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<GridTableView<S>, GridTableCell<S,T>>> cellFactoryProperty()
      Stores the factory used to create cells for this column.
      Returns:
      the cell factory property
      See Also:

    • setCellFactory

      public final void setCellFactory(javafx.util.Callback<GridTableView<S>, GridTableCell<S,T>> cellFactory)
      Sets the value of the cellFactory property.
      Property description:
      Stores the factory used to create cells for this column.
      Parameters:
      cellFactory - the value for the cellFactory property
      See Also:

    • getCellValueFactory

      public final javafx.util.Callback<S,T> getCellValueFactory()
      Gets the value of the cellValueFactory property.
      Property description:
      Stores the factory used to extract cell values from row items.
      Returns:
      the value of the cellValueFactory property
      See Also:

    • cellValueFactoryProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Callback<S,T>> cellValueFactoryProperty()
      Stores the factory used to extract cell values from row items.
      Returns:
      the cell value factory property
      See Also:

    • setCellValueFactory

      public final void setCellValueFactory(javafx.util.Callback<S,T> cellValueFactory)
      Sets the value of the cellValueFactory property.
      Property description:
      Stores the factory used to extract cell values from row items.
      Parameters:
      cellValueFactory - the value for the cellValueFactory property
      See Also:

    • getHeader

      public final javafx.scene.Node getHeader()
      Gets the value of the header property.
      Property description:
      A read-only property containing the header node.
      Returns:
      the value of the header property
      See Also:

    • headerProperty

      public final javafx.beans.property.ReadOnlyObjectProperty<javafx.scene.Node> headerProperty()
      A read-only property containing the header node.
      Returns:
      the header property
      See Also:

    • createCell

      public final GridTableCell<S,T> createCell(GridTableView<S> tableView, int index)
      Creates a new cell for the given table view and row index.
      Parameters:
      tableView - the owning table view
      index - the row index
      Returns:
      the created cell