org.controlsfx.control.spreadsheet

Class SpreadsheetView

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

org.controlsfx.control.spreadsheet.SpreadsheetView

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

public class SpreadsheetView
extends Control

The SpreadsheetView is a control similar to the JavaFX TableView control but with different functionalities and use cases. The aim is to have a powerful grid where data can be written and retrieved.

Features

• Cells can span in row and in column.
• Rows can be fixed to the top of the SpreadsheetView so that they are always visible on screen.
• Columns can be fixed to the left of the SpreadsheetView so that they are always visible on screen. Only columns without any spanning cells can be fixed.
• A row header can be switched on in order to display the row number.
• Rows can be resized just like columns with click & drag.
• Both row and column header can be visible or invisible.
• Selection of several cells can be made with a click and drag.
• A copy/paste context menu is accessible with a right-click. The usual shortcuts are also working.

Fixing Rows and Columns

You can fix some rows and some columns by right-clicking on their header. A context menu will appear if it's possible to fix them. The label will then be in italic and the background will turn to dark grey. Keep in mind that only columns without any spanning cells can be fixed.
And that and only rows without row-spanning cells can be fixed.
You have also the possibility to fix them manually by adding and removing items from getFixedRows() and getFixedColumns(). But you are strongly advised to check if it's possible to do so with SpreadsheetColumn.isColumnFixable() for the fixed columns and with isRowFixable(int) for the fixed rows. Calling those methods prior every move will ensure that no exception will be thrown.
You have also the possibility to deactivate these possibilities. For example, you force some row/column to be fixed and then the user cannot change the settings.

Headers

You can also access and toggle header's visibility by using the methods provided like setShowRowHeader(boolean) or setShowColumnHeader(boolean).

Pickers

You can show some little images next to the headers. They will appear on the left of the VerticalHeader and on top on the HorizontalHeader. They are called "picker" because they were used originally for picking a row or a column to insert in the SpreadsheetView.
But you can do anything you want with it. Simply add a row or a column index in getRowPickers() and getColumnPickers(). Then you can provide a custom CallBack with setRowPickerCallback(javafx.util.Callback) and setColumnPickerCallback(javafx.util.Callback) in order to react when the user click on the picker. The Callback gives you the index of the picker.
The pickers will appear on the top of the column's header and on the left of the row's header.
You can also override the default graphic of the picker by overriding its css, example:

 .picker-label{
   -fx-graphic: url("add.png"); 
   -fx-background-color: transparent;
   -fx-padding: 0 0 0 0;
 }
 

Copy pasting

You can copy any cell you want and paste it elsewhere. Be aware that only the value inside will be pasted, not the style nor the type. Thus the value you're trying to paste must be compatible with the SpreadsheetCellType of the receiving cell. Pasting a Double into a String will work but the reverse operation will not.
See SpreadsheetCellType Value Verification documentation for more information.
A unique cell or a selection of several of them can be copied and pasted.

Code Samples

Just like the TableView, you instantiate the underlying model, a Grid. You will create some rows filled with SpreadsheetCell.

 int rowCount = 15;
     int columnCount = 10;
     GridBase grid = new GridBase(rowCount, columnCount);
     
     ObservableList<ObservableList<SpreadsheetCell>> rows = FXCollections.observableArrayList();
     for (int row = 0; row < grid.getRowCount(); ++row) {
         final ObservableList<SpreadsheetCell> list = FXCollections.observableArrayList();
         for (int column = 0; column < grid.getColumnCount(); ++column) {
             list.add(SpreadsheetCellType.STRING.createCell(row, column, 1, 1,"value"));
         }
         rows.add(list);
     }
     grid.setRows(rows);

     SpreadsheetView spv = new SpreadsheetView(grid);
     
 

At that moment you can span some of the cells with the convenient method provided by the grid. Then you just need to instantiate the SpreadsheetView.

Visual:

See Also:

SpreadsheetCell, SpreadsheetCellBase, SpreadsheetColumn, Grid, GridBase

Property Summary

Type	Property and Description
BooleanProperty	editable Specifies whether this SpreadsheetView is editable - only if the SpreadsheetView, and the SpreadsheetCell within it are both editable will a SpreadsheetCell be able to go into its editing state.
ReadOnlyBooleanProperty	fixingColumnsAllowed Return the Boolean property associated with the allowance of fixing or unfixing some columns.
ReadOnlyBooleanProperty	fixingRowsAllowed Return the Boolean property associated with the allowance of fixing or unfixing some rows.
ReadOnlyObjectProperty<Grid>	grid Return a ReadOnlyObjectProperty containing the current Grid used in the SpreadsheetView.
BooleanProperty	showColumnHeader BooleanProperty associated with the column Header.
BooleanProperty	showRowHeader BooleanProperty associated with the row Header.

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpreadsheetView.SpanType The SpanType describes in which state each cell can be.

Field Summary

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 and Description
SpreadsheetView() Creates a default SpreadsheetView control with no content and a Grid set to null.
SpreadsheetView(Grid grid) Creates a SpreadsheetView control with the Grid specified.

Method Summary

Modifier and Type	Method and Description
void	copyClipboard() Put the current selection into the ClipBoard.
void	deleteSelectedCells() This method is called when pressing the "delete" key on the SpreadsheetView.
BooleanProperty	editableProperty() Specifies whether this SpreadsheetView is editable - only if the SpreadsheetView, and the SpreadsheetCell within it are both editable will a SpreadsheetCell be able to go into its editing state.
ReadOnlyBooleanProperty	fixingColumnsAllowedProperty() Return the Boolean property associated with the allowance of fixing or unfixing some columns.
ReadOnlyBooleanProperty	fixingRowsAllowedProperty() Return the Boolean property associated with the allowance of fixing or unfixing some rows.
Callback<Integer,Void>	getColumnPickerCallback()
ObservableList<Integer>	getColumnPickers()
ObservableList<SpreadsheetColumn>	getColumns() Return an unmodifiable observableList of the SpreadsheetColumn used.
TablePosition<ObservableList<SpreadsheetCell>,?>	getEditingCell() Return a TablePosition of cell being currently edited.
Optional<SpreadsheetCellEditor>	getEditor(SpreadsheetCellType<?> cellType) Return the editor associated with the CellType.
ObservableList<SpreadsheetColumn>	getFixedColumns() You can fix or unfix a column by modifying this list.
ObservableList<Integer>	getFixedRows() You can fix or unfix a row by modifying this list.
Grid	getGrid() Return the model Grid used by the SpreadsheetView
double	getRowHeight(int row)
Callback<Integer,Void>	getRowPickerCallback()
ObservableList<Integer>	getRowPickers()
TableView.TableViewSelectionModel<ObservableList<SpreadsheetCell>>	getSelectionModel() Return the selectionModel used by the SpreadsheetView.
SpreadsheetView.SpanType	getSpanType(int row, int column) Return the SpreadsheetView.SpanType of a cell, this is a shorcut for Grid.getSpanType(org.controlsfx.control.spreadsheet.SpreadsheetView, int, int).
ContextMenu	getSpreadsheetViewContextMenu() Create a menu on rightClick with two options: Copy/Paste This can be overridden by developers for custom behavior.
ReadOnlyObjectProperty<Grid>	gridProperty() Return a ReadOnlyObjectProperty containing the current Grid used in the SpreadsheetView.
boolean	isColumnFixable(int columnIndex) Indicate whether this column can be fixed or not.
boolean	isEditable() Gets the value of the property editable.
boolean	isFixingColumnsAllowed() Return whether change to Fixed columns are allowed.
boolean	isFixingRowsAllowed() Return whether change to Fixed rows are allowed.
boolean	isRowFixable(int row) Indicate whether a row can be fixed or not.
boolean	isShowColumnHeader() Return if the Column Header is showing.
boolean	isShowRowHeader() Return if the row Header is showing.
void	pasteClipboard() Try to paste the clipBoard to the specified position.
void	resizeRowsToDefault() This method will wipe all changes made to the row's height and set all row's height back to their default height defined in the model Grid.
void	resizeRowsToFitContent() This method will compute the best height for each line.
void	resizeRowsToMaximum() This method will first apply resizeRowsToFitContent() and then take the highest height and apply it to every row.\n Just as resizeRowsToFitContent(), this method can be degrading your performance on great grid.
void	setColumnPickerCallback(Callback<Integer,Void> callback) Set a custom callback for the Column picker.
void	setEditable(boolean b) Sets the value of the property editable.
void	setFixingColumnsAllowed(boolean b) If set to true, user will be allowed to fix and unfix the columns.
void	setFixingRowsAllowed(boolean b) If set to true, user will be allowed to fix and unfix the rows.
void	setGrid(Grid grid) Set a new Grid for the SpreadsheetView.
void	setRowPickerCallback(Callback<Integer,Void> callback) Set a custom callback for the Row picker.
void	setShowColumnHeader(boolean b) Activate and deactivate the Column Header
void	setShowRowHeader(boolean b) Activate and deactivate the Row Header.
BooleanProperty	showColumnHeaderProperty() BooleanProperty associated with the column Header.
BooleanProperty	showRowHeaderProperty() BooleanProperty associated with the row Header.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, createDefaultSkin, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getSkin, getTooltip, getUserAgentStylesheet, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinClassNameProperty, 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, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_geomChanged, impl_getAccessible, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, 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, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, screenToLocal, screenToLocal, screenToLocal, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

grid

public final ReadOnlyObjectProperty<Grid> gridProperty

Return a ReadOnlyObjectProperty containing the current Grid used in the SpreadsheetView.

See Also:

getGrid(), setGrid(Grid)

fixingRowsAllowed

public ReadOnlyBooleanProperty fixingRowsAllowedProperty

Return the Boolean property associated with the allowance of fixing or unfixing some rows.

See Also:

isFixingRowsAllowed(), setFixingRowsAllowed(boolean)

fixingColumnsAllowed

public ReadOnlyBooleanProperty fixingColumnsAllowedProperty

Return the Boolean property associated with the allowance of fixing or unfixing some columns.

See Also:

isFixingColumnsAllowed(), setFixingColumnsAllowed(boolean)

showColumnHeader

public final BooleanProperty showColumnHeaderProperty

BooleanProperty associated with the column Header.

See Also:

isShowColumnHeader(), setShowColumnHeader(boolean)

showRowHeader

public final BooleanProperty showRowHeaderProperty

BooleanProperty associated with the row Header.

See Also:

isShowRowHeader(), setShowRowHeader(boolean)

editable

public final BooleanProperty editableProperty

Specifies whether this SpreadsheetView is editable - only if the SpreadsheetView, and the SpreadsheetCell within it are both editable will a SpreadsheetCell be able to go into its editing state.

See Also:

isEditable(), setEditable(boolean)

Constructor Detail

SpreadsheetView

public SpreadsheetView()

Creates a default SpreadsheetView control with no content and a Grid set to null.

SpreadsheetView

public SpreadsheetView(Grid grid)

Creates a SpreadsheetView control with the Grid specified.

Parameters:

grid - The Grid that contains the items to be rendered

Method Detail

setGrid

public final void setGrid(Grid grid)

Set a new Grid for the SpreadsheetView. This will be called by default by SpreadsheetView(Grid). So this is useful when you want to refresh your SpreadsheetView with a new model. This will keep the state of your SpreadsheetView (position of the bar, number of fixedRows etc).

Parameters:

grid - the new Grid

getEditingCell

public TablePosition<ObservableList<SpreadsheetCell>,?> getEditingCell()

Return a TablePosition of cell being currently edited.

Returns:

a TablePosition of cell being currently edited.

getColumns

public ObservableList<SpreadsheetColumn> getColumns()

Return an unmodifiable observableList of the SpreadsheetColumn used.

Returns:

An unmodifiable observableList.

getGrid

public final Grid getGrid()

Return the model Grid used by the SpreadsheetView

Returns:

the model Grid used by the SpreadsheetView

gridProperty

public final ReadOnlyObjectProperty<Grid> gridProperty()

Return a ReadOnlyObjectProperty containing the current Grid used in the SpreadsheetView.

See Also:

getGrid(), setGrid(Grid)

getFixedRows

public ObservableList<Integer> getFixedRows()

You can fix or unfix a row by modifying this list. Call isRowFixable(int) before trying to fix a row. See SpreadsheetView description for information.

Returns:

an ObservableList of integer representing the fixedRows.

isRowFixable

public boolean isRowFixable(int row)

Indicate whether a row can be fixed or not. Call that method before adding an item with getFixedRows() .

Parameters:

row -

Returns:

true if the row can be fixed.

isFixingRowsAllowed

public boolean isFixingRowsAllowed()

Return whether change to Fixed rows are allowed.

Returns:

whether change to Fixed rows are allowed.

setFixingRowsAllowed

public void setFixingRowsAllowed(boolean b)

If set to true, user will be allowed to fix and unfix the rows.

Parameters:

b -

fixingRowsAllowedProperty

public ReadOnlyBooleanProperty fixingRowsAllowedProperty()

Return the Boolean property associated with the allowance of fixing or unfixing some rows.

See Also:

isFixingRowsAllowed(), setFixingRowsAllowed(boolean)

getFixedColumns

public ObservableList<SpreadsheetColumn> getFixedColumns()

You can fix or unfix a column by modifying this list. Call SpreadsheetColumn.isColumnFixable() on the column before adding an item.

Returns:

an ObservableList of the fixed columns.

isColumnFixable

public boolean isColumnFixable(int columnIndex)

Indicate whether this column can be fixed or not. If you have a SpreadsheetColumn, call SpreadsheetColumn.isColumnFixable() on it directly. Call that method before adding an item with getFixedColumns() .

Parameters:

columnIndex -

Returns:

true if the column if fixable

isFixingColumnsAllowed

public boolean isFixingColumnsAllowed()

Return whether change to Fixed columns are allowed.

Returns:

whether change to Fixed columns are allowed.

setFixingColumnsAllowed

public void setFixingColumnsAllowed(boolean b)

If set to true, user will be allowed to fix and unfix the columns.

Parameters:

b -

fixingColumnsAllowedProperty

public ReadOnlyBooleanProperty fixingColumnsAllowedProperty()

Return the Boolean property associated with the allowance of fixing or unfixing some columns.

See Also:

isFixingColumnsAllowed(), setFixingColumnsAllowed(boolean)

setShowColumnHeader

public final void setShowColumnHeader(boolean b)

Activate and deactivate the Column Header

Parameters:

b -

isShowColumnHeader

public final boolean isShowColumnHeader()

Return if the Column Header is showing.

Returns:

a boolean telling whether the column Header is shown

showColumnHeaderProperty

public final BooleanProperty showColumnHeaderProperty()

BooleanProperty associated with the column Header.

See Also:

isShowColumnHeader(), setShowColumnHeader(boolean)

setShowRowHeader

public final void setShowRowHeader(boolean b)

Activate and deactivate the Row Header.

Parameters:

b -

isShowRowHeader

public final boolean isShowRowHeader()

Return if the row Header is showing.

Returns:

a boolean telling if the row Header is being shown

showRowHeaderProperty

public final BooleanProperty showRowHeaderProperty()

BooleanProperty associated with the row Header.

See Also:

isShowRowHeader(), setShowRowHeader(boolean)

getRowPickers

public ObservableList<Integer> getRowPickers()

Returns:

An ObservableList of row indexes that display a picker.

setRowPickerCallback

public void setRowPickerCallback(Callback<Integer,Void> callback)

Set a custom callback for the Row picker. Row number is given to you in the callback.

Parameters:

callback -

getRowPickerCallback

public Callback<Integer,Void> getRowPickerCallback()

Returns:

the row Picker Callback.

getColumnPickers

public ObservableList<Integer> getColumnPickers()

Returns:

An ObservableList of column indexes that display a picker.

setColumnPickerCallback

public void setColumnPickerCallback(Callback<Integer,Void> callback)

Set a custom callback for the Column picker. Column number is given to you in the callback.

Parameters:

callback -

getColumnPickerCallback

public Callback<Integer,Void> getColumnPickerCallback()

Returns:

the columnPicker Callback.

resizeRowsToFitContent

public void resizeRowsToFitContent()

This method will compute the best height for each line. That is to say a height where each content of each cell could be fully visible.\n Use this method wisely because it can degrade performance on great grid.

resizeRowsToMaximum

public void resizeRowsToMaximum()

This method will first apply resizeRowsToFitContent() and then take the highest height and apply it to every row.\n Just as resizeRowsToFitContent(), this method can be degrading your performance on great grid.

resizeRowsToDefault

public void resizeRowsToDefault()

This method will wipe all changes made to the row's height and set all row's height back to their default height defined in the model Grid.

getRowHeight

public double getRowHeight(int row)

Parameters:

row -

Returns:

the height of a particular row of the SpreadsheetView.

getSelectionModel

public TableView.TableViewSelectionModel<ObservableList<SpreadsheetCell>> getSelectionModel()

Return the selectionModel used by the SpreadsheetView.

Returns:

TableView.TableViewSelectionModel

getEditor

public final Optional<SpreadsheetCellEditor> getEditor(SpreadsheetCellType<?> cellType)

Return the editor associated with the CellType. (defined in SpreadsheetCellType.createEditor(SpreadsheetView). FIXME Maybe keep the editor references inside the SpreadsheetCellType

Parameters:

cellType -

Returns:

the editor associated with the CellType.

setEditable

public final void setEditable(boolean b)

Sets the value of the property editable.

Parameters:

b -

isEditable

public final boolean isEditable()

Gets the value of the property editable.

Returns:

a boolean telling if the SpreadsheetView is editable.

editableProperty

public final BooleanProperty editableProperty()

Specifies whether this SpreadsheetView is editable - only if the SpreadsheetView, and the SpreadsheetCell within it are both editable will a SpreadsheetCell be able to go into its editing state.

See Also:

isEditable(), setEditable(boolean)

copyClipboard

public void copyClipboard()

Put the current selection into the ClipBoard. This can be overridden by developers for custom behavior.

pasteClipboard

public void pasteClipboard()

Try to paste the clipBoard to the specified position. Try to paste the current selection into the Grid. If the two contents are not matchable, then it's not pasted. This can be overridden by developers for custom behavior.

getSpreadsheetViewContextMenu

public ContextMenu getSpreadsheetViewContextMenu()

Create a menu on rightClick with two options: Copy/Paste This can be overridden by developers for custom behavior.

Returns:

the ContextMenu to use.

deleteSelectedCells

public void deleteSelectedCells()

This method is called when pressing the "delete" key on the SpreadsheetView. This will erase the values of selected cells. This can be overridden by developers for custom behavior.

getSpanType

public SpreadsheetView.SpanType getSpanType(int row,
                                            int column)

Return the SpreadsheetView.SpanType of a cell, this is a shorcut for Grid.getSpanType(org.controlsfx.control.spreadsheet.SpreadsheetView, int, int).

Parameters:

row -

column -

Returns:

The SpreadsheetView.SpanType of a cell