Module org.controlsfx.controls
Package org.controlsfx.control.spreadsheet

Interface SpreadsheetCell

All Known Implementing Classes:
SpreadsheetCellBase
public interface SpreadsheetCell
Interface of the cells used in the SpreadsheetView. See SpreadsheetCellBase for a complete and detailed documentation.
See Also:

  • Property Details

  • Field Details

    • EDITABLE_EVENT_TYPE

      static final EventType<Event> EDITABLE_EVENT_TYPE
      This EventType can be used with an EventHandler in order to catch when the editable state of a SpreadsheetCell is changed.

    • WRAP_EVENT_TYPE

      static final EventType<Event> WRAP_EVENT_TYPE
      This EventType can be used with an EventHandler in order to catch when the wrap text state of a SpreadsheetCell is changed.

    • CORNER_EVENT_TYPE

      static final EventType<Event> CORNER_EVENT_TYPE
      This EventType can be used with an EventHandler in order to catch when a corner state of a SpreadsheetCell is changed.

  • Method Details

    • match

      boolean match(Object value)
      Verifies that the upcoming cell value can be set to the current cell. This is currently used by the Copy/Paste.
      Parameters:
      value - the value that needs to be tested
      Returns:
      true if the upcoming cell value can be set to the current cell

    • setItem

      void setItem(Object value)
      Sets the value of the property Item. This should be used only at initialization. Prefer Grid.setCellValue(int, int, Object) after because it will compute correctly the modifiedCell. If isEditable() return false, nothing is done.
      Parameters:
      value -

    • getItem

      Object getItem()
      Returns the value contained in this cell.
      Returns:
      the value contained in this cell

    • itemProperty

      ObjectProperty<Object> itemProperty()
      The item property represents the currently-set value inside this SpreadsheetCell.
      See Also:

    • isEditable

      boolean isEditable()
      Returns true if this cell can be edited.
      Returns:
      true if this cell is editable

    • setEditable

      void setEditable(boolean editable)
      Change the editable state of this cell
      Parameters:
      editable - true if this cell should be editable

    • isWrapText

      boolean isWrapText()
      If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.
      Returns:
      true if the text should wrap onto another line if it exceeds the width of the Labeled

    • isCellGraphic

      boolean isCellGraphic()
      Returns true if this cell contains something particular in its item and a Node given by the CellGraphicFactory will be used to display it.
      Returns:
      true if this cell item needs to be given to a particular Node

    • setCellGraphic

      void setCellGraphic(boolean isCellGraphic)
      If isCellGraphic is true, this cell item contains something particular and should be display by using CellGraphicFactory object in the CellView.
      Parameters:
      isCellGraphic - if true, a Node will be used to display something particular for the cell

    • setWrapText

      void setWrapText(boolean wrapText)
      If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line.
      Parameters:
      wrapText - true if the text should wrap onto another line if it exceeds the width of the Labeled

    • getOptionsForEditor

      List<Object> getOptionsForEditor()
      If some options cannot be factorized in a SpreadsheetCellType and are specific to a cell, you can return them here and the SpreadsheetCellEditor will receive them.
      Returns:
      a List of options for the SpreadsheetCellEditor

    • hasPopup

      boolean hasPopup()
      Returns true if this cell needs to display a popup when clicked in order to show some MenuItem like a MenuButton. The items can be set in getPopupItems().
      Returns:
      true if this cell needs to display a popup

    • setHasPopup

      void setHasPopup(boolean value)
      Sets to true if this cell needs to display a popup when clicked in order to show some MenuItem like a MenuButton.
      Parameters:
      value - true to display a Popup when clicked

    • getPopupItems

      List<MenuItem> getPopupItems()
      If hasPopup() is set to true, this method will be called when the user clicks on the cell in order to gather the MenuItem to show in the Popup.
      Returns:
      the MenuItem to show in the Popup

    • setStyle

      void setStyle(String style)
      A string representation of the CSS style associated with this specific Node. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.
      Parameters:
      style - a string representation of the CSS style associated with this specific Node

    • getStyle

      String getStyle()
      A string representation of the CSS style associated with this specific Node. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.
      Returns:
      The inline CSS style associated with this Node. If this Node does not have an inline style, an empty String is returned.

    • styleProperty

      StringProperty styleProperty()
      A string representation of the CSS style associated with this specific Node. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.
      See Also:

    • activateCorner

      void activateCorner(SpreadsheetCell.CornerPosition position)
      Activates the given CornerPosition in order to display a little triangle in the cell.
      Parameters:
      position - the position where the triangle should be displayed

    • deactivateCorner

      void deactivateCorner(SpreadsheetCell.CornerPosition position)
      This deactivates the given CornerPosition so that no triangle will be shown for this cell.
      Parameters:
      position - the position where the triangle should be removed if displayed

    • isCornerActivated

      boolean isCornerActivated(SpreadsheetCell.CornerPosition position)
      Returns true if a triangle is displayed in the cell for the given CornerPosition.
      Parameters:
      position -
      Returns:
      true if a triangle is displayed in the cell for the given CornerPosition

    • formatProperty

      StringProperty formatProperty()
      Returns the StringProperty linked with the format.
      See Also:

    • getFormat

      String getFormat()
      Returns the format of this cell or an empty string if no format has been specified.
      Returns:
      the format of this cell or an empty string if no format has been specified

    • setFormat

      void setFormat(String format)
      Sets a new format for this cell. This format will be used by SpreadsheetCellType.toString(java.lang.Object, java.lang.String). This should be used by numbers for example.
      Parameters:
      format - a string pattern understood by the SpreadsheetCellType

    • textProperty

      ReadOnlyStringProperty textProperty()
      Returns the StringProperty of the representation of the value.
      See Also:

    • getText

      String getText()
      Returns the String representation currently used for display in the SpreadsheetView.
      Returns:
      the text representation of the value

    • getCellType

      SpreadsheetCellType getCellType()
      Returns the SpreadsheetCellType of this cell.
      Returns:
      the SpreadsheetCellType of this cell.

    • getRow

      int getRow()
      Returns the row index of this cell.
      Returns:
      the row index of this cell

    • getColumn

      int getColumn()
      Returns the column index of this cell.
      Returns:
      the column index of this cell

    • getRowSpan

      int getRowSpan()
      Returns how much this cell is spanning in row, 1 means the cell is not spanning.
      Returns:
      how much this cell is spanning in row, 1 is normal

    • setRowSpan

      void setRowSpan(int rowSpan)
      Sets how much this cell is spanning in row. See SpreadsheetCell description for information. You should use Grid.spanRow(int, int, int) instead of using this method directly. 1 means the cell is not spanning. Thus, the rowSpan should not be inferior to 1.
      Parameters:
      rowSpan - the rowSpan for this cell

    • getColumnSpan

      int getColumnSpan()
      Returns how much this cell is spanning in column, 1 means the cell is not spanning.
      Returns:
      how much this cell is spanning in column, 1 is normal.

    • setColumnSpan

      void setColumnSpan(int columnSpan)
      Sets how much this cell is spanning in column. See SpreadsheetCell description for information. You should use Grid.spanColumn(int, int, int) instead of using this method directly. 1 means the cell is not spanning. Thus, the rowSpan should not be inferior to 1.
      Parameters:
      columnSpan - the columnSpan for this cell

    • getStyleClass

      ObservableSet<String> getStyleClass()
      Returns an ObservableList of String of all the style class associated with this cell. You can easily modify its appearance by adding a style class (previously set in CSS).
      Returns:
      an ObservableList of String of all the style class of this cell

    • graphicProperty

      ObjectProperty<Node> graphicProperty()
      Returns the ObjectProperty representing this cell graphic.
      See Also:

    • setGraphic

      void setGraphic(Node graphic)
      Sets a graphic for this cell. It is displayed aside with the text if any is specified. Otherwise it's fully displayed in the cell.
      Parameters:
      graphic - a graphic to display for this cell

    • getGraphic

      Node getGraphic()
      Returns the graphic node associated with this cell. Returns null if nothing has been associated.
      Returns:
      the graphic node associated with this cell

    • getTooltip

      Optional<String> getTooltip()
      Returns the tooltip for this cell.
      Returns:
      the tooltip associated with this SpreadsheetCell

    • addEventHandler

      <E extends Event> void addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)
      Registers an event handler to this SpreadsheetCell.
      Parameters:
      eventType - the type of the events to receive by the handler
      eventHandler - the handler to register
      Throws:
      NullPointerException - if the event type or handler is null

    • removeEventHandler

      <E extends Event> void removeEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)
      Unregisters a previously registered event handler from this SpreadsheetCell.
      Parameters:
      eventType - the event type from which to unregister
      eventHandler - the handler to unregister
      Throws:
      NullPointerException - if the event type or handler is null