Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXTableColumn<T>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.Labeled

io.github.palexdev.materialfx.controls.MFXTableColumn<T>

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

public class MFXTableColumn<T>
extends Labeled

This is the implementation of the column cells used in the MFXTableView control.

To make it easily customizable, extends Labeled and provides a new default skin, MFXTableColumnSkin.

Defines the following new PseudoClasses for usage in CSS:

- ":dragged", to customize the column when it is dragged

- ":resizable", to customize the column depending on columnResizableProperty()

Each column cell has the following responsibilities: -

Has a row cell factory because each column knows how to build the corresponding row cell in each table row -

Has a sort state and a comparator because each column knows how to sort the rows based on the given comparator, also retains its sort state thus allowing switching between ASCENDING, DESCENDING, UNSORTED

Some side notes...

Even if not specified by the user, the rowCellFactoryProperty() will always bind the new cells' width to the width of the column, this is needed to make the columns autosize and the DragResizer work properly.

The columnResizableProperty() controls the DragResizer, installing it if true and uninstalling it if false. All columns by default have a minimum width set to 100, can be changed of course as you like.

Unlike the old implementation, where all the "system" was managed by the table view skin, the new implementation vastly improves the separation of roles. The cells' width (mentioned before), the sorting and the icon animation are all handled by the columns now. To communicate with the table skin, the table column now uses Events, see MFXTableColumn.MFXTableColumnEvent.

See Also:

• MFXTableColumnSkin

Property Summary

Properties

Type	Property	Description
BooleanProperty	columnResizable	Specifies whether the column can be resized.
ComparatorProperty<T>	comparator	Specifies the Comparator used to sort the column.
ReadOnlyBooleanProperty	dragged	Specifies whether the column is being dragged.
FunctionProperty<T,MFXTableRowCell<T,?>>	rowCellFactory	Specifies the Function used to build the row's cells.
ObjectProperty<SortState>	sortState	Specifies the sort state of the column.

Properties inherited from class javafx.scene.control.Labeled

alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, lineSpacing, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapText

Properties inherited from class javafx.scene.control.Control

contextMenu, skin, tooltip

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MFXTableColumn.MFXTableColumnEvent<T>	This class introduces new Events for MFXTableColumns, such as:

Field Summary

Fields

Modifier and Type	Field	Description
protected static final PseudoClass	DRAGGED_PSEUDO_CLASS
protected static final PseudoClass	RESIZABLE_PSEUDO_CLASS

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor	Description
MFXTableColumn()
MFXTableColumn(String name)
MFXTableColumn(String name, boolean resizable)
MFXTableColumn(String text, boolean resizable, Comparator<T> comparator)
MFXTableColumn(String text, Comparator<T> comparator)

Method Summary

Modifier and Type	Method	Description
BooleanProperty	columnResizableProperty()	Specifies whether the column can be resized.
ComparatorProperty<T>	comparatorProperty()	Specifies the Comparator used to sort the column.
protected Skin<?>	createDefaultSkin()
ReadOnlyBooleanProperty	draggedProperty()	Specifies whether the column is being dragged.
Comparator<T>	getComparator()	Gets the value of the property comparator.
Function<T,MFXTableRowCell<T,?>>	getRowCellFactory()	Gets the value of the property rowCellFactory.
SortState	getSortState()	Gets the value of the property sortState.
String	getUserAgentStylesheet()
boolean	isColumnResizable()	Gets the value of the property columnResizable.
boolean	isDragged()	Gets the value of the property dragged.
FunctionProperty<T,MFXTableRowCell<T,?>>	rowCellFactoryProperty()	Specifies the Function used to build the row's cells.
void	setColumnResizable(boolean columnResizable)	Sets the value of the property columnResizable.
void	setComparator(Comparator<T> comparator)	Sets the value of the property comparator.
protected void	setDragged(boolean dragged)	Sets the value of the property dragged.
void	setRowCellFactory(Function<T,MFXTableRowCell<T,?>> rowCellFactory)	Sets the value of the property rowCellFactory.
void	setSortState(SortState sortState)	Sets the value of the property sortState.
ObjectProperty<SortState>	sortStateProperty()	Specifies the sort state of the column.

Methods inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getControlCssMetaData, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getInitialAlignment, getLabelPadding, getLineSpacing, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setLineSpacing, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, toString, underlineProperty, wrapTextProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Property Details

rowCellFactory

public FunctionProperty<T,MFXTableRowCell<T,?>> rowCellFactoryProperty

Specifies the Function used to build the row's cells.

See Also:

• getRowCellFactory()
• setRowCellFactory(Function)

sortState

public ObjectProperty<SortState> sortStateProperty

Specifies the sort state of the column.

See Also:

• getSortState()
• setSortState(SortState)

comparator

public ComparatorProperty<T> comparatorProperty

Specifies the Comparator used to sort the column.

See Also:

• getComparator()
• setComparator(Comparator)

dragged

public ReadOnlyBooleanProperty draggedProperty

Specifies whether the column is being dragged.

See Also:

• isDragged()
• setDragged(boolean)

columnResizable

public BooleanProperty columnResizableProperty

Specifies whether the column can be resized.

See Also:

• isColumnResizable()
• setColumnResizable(boolean)

Field Details

DRAGGED_PSEUDO_CLASS

protected static final PseudoClass DRAGGED_PSEUDO_CLASS

RESIZABLE_PSEUDO_CLASS

protected static final PseudoClass RESIZABLE_PSEUDO_CLASS

Constructor Details

MFXTableColumn

public MFXTableColumn()

MFXTableColumn

public MFXTableColumn(String name)

MFXTableColumn

public MFXTableColumn(String name,
 boolean resizable)

MFXTableColumn

public MFXTableColumn(String text,
 Comparator<T> comparator)

MFXTableColumn

public MFXTableColumn(String text,
 boolean resizable,
 Comparator<T> comparator)

Method Details

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

getUserAgentStylesheet

public String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class Region

getRowCellFactory

public Function<T,MFXTableRowCell<T,?>> getRowCellFactory()

Gets the value of the property rowCellFactory.

Property description:

Specifies the Function used to build the row's cells.

rowCellFactoryProperty

public FunctionProperty<T,MFXTableRowCell<T,?>> rowCellFactoryProperty()

Specifies the Function used to build the row's cells.

See Also:

• getRowCellFactory()
• setRowCellFactory(Function)

setRowCellFactory

public void setRowCellFactory(Function<T,MFXTableRowCell<T,?>> rowCellFactory)

Sets the value of the property rowCellFactory.

Property description:

Specifies the Function used to build the row's cells.

getSortState

public SortState getSortState()

Gets the value of the property sortState.

Property description:

Specifies the sort state of the column.

sortStateProperty

public ObjectProperty<SortState> sortStateProperty()

Specifies the sort state of the column.

See Also:

• getSortState()
• setSortState(SortState)

setSortState

public void setSortState(SortState sortState)

Sets the value of the property sortState.

Property description:

Specifies the sort state of the column.

getComparator

public Comparator<T> getComparator()

Gets the value of the property comparator.

Property description:

Specifies the Comparator used to sort the column.

comparatorProperty

public ComparatorProperty<T> comparatorProperty()

Specifies the Comparator used to sort the column.

See Also:

• getComparator()
• setComparator(Comparator)

setComparator

public void setComparator(Comparator<T> comparator)

Sets the value of the property comparator.

Property description:

Specifies the Comparator used to sort the column.

isDragged

public boolean isDragged()

Gets the value of the property dragged.

Property description:

Specifies whether the column is being dragged.

draggedProperty

public ReadOnlyBooleanProperty draggedProperty()

Specifies whether the column is being dragged.

See Also:

• isDragged()
• setDragged(boolean)

setDragged

protected void setDragged(boolean dragged)

Sets the value of the property dragged.

Property description:

Specifies whether the column is being dragged.

isColumnResizable

public boolean isColumnResizable()

Gets the value of the property columnResizable.

Property description:

Specifies whether the column can be resized.

columnResizableProperty

public BooleanProperty columnResizableProperty()

Specifies whether the column can be resized.

See Also:

• isColumnResizable()
• setColumnResizable(boolean)

setColumnResizable

public void setColumnResizable(boolean columnResizable)

Sets the value of the property columnResizable.

Property description:

Specifies whether the column can be resized.