Packages

class TableColumn[S, T] extends TableColumnBase[S, T] with SFXDelegate[javafx.scene.control.TableColumn[S, T]]

Source
TableColumn.scala
Linear Supertypes
TableColumnBase[S, T], Styleable, SFXDelegate[javafx.scene.control.TableColumn[S, T]], EventHandlerDelegate1, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TableColumn
  2. TableColumnBase
  3. Styleable
  4. SFXDelegate
  5. EventHandlerDelegate1
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TableColumn(text: String)

    Creates a TableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation.

  2. new TableColumn(delegate: javafx.scene.control.TableColumn[S, T] = new jfxsc.TableColumn[S, T]())

Type Members

  1. trait EventHandled extends AnyRef

    Trait used for handle events manipulation.

    Trait used for handle events manipulation. JavaFX class wrapped must have methods defined in scalafx.event.EventHandlerDelegate1.EventHandled Type:

    def addEventHandler   [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[E])
    def removeEventHandler[E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[E])
    def addEventFilter    [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[E])
    def removeEventFilter [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[E])
    def buildEventDispatchChain(chain: jfxe.EventDispatchChain): jfxe.EventDispatchChain
    Definition Classes
    EventHandlerDelegate1
  2. sealed trait FilterMagnet[J <: javafx.event.Event, S <: SFXDelegate[J]] extends AnyRef

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate1
  3. sealed trait HandlerMagnet[J <: javafx.event.Event, S <: SFXDelegate[J]] extends AnyRef

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate1

Value Members

  1. object FilterMagnet

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate1
  2. object HandlerMagnet

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate1
  3. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def ##: Int
    Definition Classes
    AnyRef → Any
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[E]): Unit

    Registers an event filter to this task.

    Registers an event filter to this task. Registered event filters get an event before any associated event handlers.

    E

    Event class

    eventType

    the type of the events to receive by the filter

    eventHandler

    the filter to register that will filter event

    Definition Classes
    EventHandlerDelegate1
  7. def addEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[E]): Unit

    Registers an event handler to this task.

    Registers an event handler to this task. Any event filters are first processed, then the specified onFoo event handlers, and finally any event handlers registered by this method. As with other events in the scene graph, if an event is consumed, it will not continue dispatching.

    E

    Event class

    eventType

    the type of the events to receive by the handler

    eventHandler

    the handler to register that will manipulate event

    Definition Classes
    EventHandlerDelegate1
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

    Construct an event dispatch chain for this target.

    Construct an event dispatch chain for this target.

    Definition Classes
    EventHandlerDelegate1
  10. def cellFactory: ObjectProperty[Callback[javafx.scene.control.TableColumn[S, T], javafx.scene.control.TableCell[S, T]]]

    The cell factory for all cells in this column.

  11. def cellFactory_=(op: (TableCell[S, T], T) => Unit): Unit

    This is a helper method for easy creation of custom cell factories.

    This is a helper method for easy creation of custom cell factories. The custom cell is automatically created, and it handles rendering of empty cells. The user is only responsible for providing an operation op that renders non-empty cells.

    The operation op provides as input the already created custom cell and value of that cell. The value is provided by the cellValueFactory. The value is guaranteed to be non null. The null values are automatically rendered as empty cells by the provided cell object.

    Here is an example where value's type is a case class Person that contains two text fields: firstName and lastName.

    case class Person(firstName:String, lastName:String)
    ...
    
    cellFactory = (cell, value) => {
      cell.text = value.firstName + " " + value.lastName
    }

    Another example where 'value' is of type 'Color' and the cell factory creates a circle representing that color:

    cellFactory = (cell, value) => {
      cell.graphic = new Circle {
         fill = value
         radius = 8
      }
    }
    op

    a method that will create content for a given cell. It gets as an input automatically created custom cell and a non-null value of that cell. op is called in the cell's updateItem method.

  12. def cellFactory_=(callback: Callback[javafx.scene.control.TableColumn[S, T], javafx.scene.control.TableCell[S, T]]): Unit
  13. def cellValueFactory: ObjectProperty[(CellDataFeatures[S, T]) => ObservableValue[T, T]]

    The cell value factory needs to be set to specify how to populate all cells within a single TableColumn.

    The cell value factory needs to be set to specify how to populate all cells within a single TableColumn.

    class Position(name_ : String, value_ : Int) {
      val name = new StringProperty(this, "name", name_)
      val value = new ObjectProperty[Int](this, "value", value_)
    }
    
    val tableView = new TableView[Position](data) {
      columns ++= List(
        new TableColumn[Position, String] {
          text = "Position"
          cellValueFactory = {_.value.name}
          prefWidth = 180
        },
        new TableColumn[Position, Int] {
          text = "Value"
          cellValueFactory = {_.value.value}
          prefWidth = 180
        }
      )
    }
  14. def cellValueFactory_=(f: (CellDataFeatures[S, T]) => ObservableValue[T, T]): Unit
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  16. def columns: ObservableBuffer[javafx.scene.control.TableColumn[S, _]]

    This enables support for nested columns, which can be useful to group together related data.

    This enables support for nested columns, which can be useful to group together related data.

    Definition Classes
    TableColumnTableColumnBase
  17. def comparator: ObjectProperty[Comparator[T]]

    Comparator function used when sorting this TableColumnBase.

    Comparator function used when sorting this TableColumnBase.

    Definition Classes
    TableColumnBase
  18. def comparator_=(v: Ordering[T]): Unit
    Definition Classes
    TableColumnBase
  19. def contextMenu: ObjectProperty[javafx.scene.control.ContextMenu]

    This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.

    This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.

    Definition Classes
    TableColumnBase
  20. def contextMenu_=(v: ContextMenu): Unit
    Definition Classes
    TableColumnBase
  21. def cssMetaData: Seq[CssMetaData[_ <: Styleable, _]]

    The CssMetaData of this Styleable.

    The CssMetaData of this Styleable.

    Definition Classes
    Styleable
  22. val delegate: javafx.scene.control.TableColumn[S, T]

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    TableColumnTableColumnBaseSFXDelegate
  23. def editable: BooleanProperty

    Specifies whether this TableColumnBase allows editing.

    Specifies whether this TableColumnBase allows editing.

    Definition Classes
    TableColumnBase
  24. def editable_=(v: Boolean): Unit
    Definition Classes
    TableColumnBase
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(ref: Any): Boolean

    Verifies if a object is equals to this delegate.

    Verifies if a object is equals to this delegate.

    ref

    Object to be compared.

    returns

    if the other object is equals to this delegate or not.

    Definition Classes
    SFXDelegate → AnyRef → Any
  27. def eventHandlerDelegate: EventHandled

    Returns a object that implements scalafx.event.EventHandlerDelegate1.EventHandled.

    Returns a object that implements scalafx.event.EventHandlerDelegate1.EventHandled.

    Definition Classes
    TableColumnBaseEventHandlerDelegate1
  28. def filterEvent[J <: Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(filter: FilterMagnet[J, S]): Subscription

    Registers an event filter.

    Registers an event filter. Registered event filters get an event before any associated event handlers.

    Example of filtering mouse events

    pane.filterEvent(MouseEvent.Any) {
      me: MouseEvent => {
        me.eventType match {
          case MouseEvent.MousePressed => {
            ...
          }
          case MouseEvent.MouseDragged => {
            ...
          }
          case _ => {
            ...
          }
        }
      }
    }

    or

    pane.filterEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
    J

    type JavaFX delegate of the event

    S

    ScalaFX type for J type wrapper.

    eventType

    type of events that will be handled.

    filter

    code handling the event, see examples above.

    Definition Classes
    EventHandlerDelegate1
  29. def getCellData(index: S): T

    Returns the actual value for a cell from the given item.

    Returns the actual value for a cell from the given item.

    Definition Classes
    TableColumnBase
  30. def getCellData(index: Int): T

    Returns the actual value for a cell at a given row index (and which belongs to this TableColumnBase).

    Returns the actual value for a cell at a given row index (and which belongs to this TableColumnBase).

    Definition Classes
    TableColumnBase
  31. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. def getId: String

    The id of this Styleable.

    The id of this Styleable.

    IMPLEMENTATION NOTE: For this method was adopted the name getId instead id to not conflict with its subclasses already have a method with this name which returns a StringProperty.

    Definition Classes
    Styleable
  33. def getStyle: String

    A string representation of the CSS style associated with this specific Node.

    A string representation of the CSS style associated with this specific Node.

    IMPLEMENTATION NOTE: For this method was adopted the name getStyle instead style to not conflict with its subclasses already have a method with this name which returns a StringProperty.

    Definition Classes
    Styleable
  34. def graphic: ObjectProperty[javafx.scene.Node]

    The graphic in the TableColumnBase.

    The graphic in the TableColumnBase.

    Definition Classes
    TableColumnBase
  35. def graphic_=(v: Node): Unit
    Definition Classes
    TableColumnBase
  36. def handleEvent[J <: Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(handler: HandlerMagnet[J, S]): Subscription

    Registers an event handler.

    Registers an event handler. The handler is called when the node receives an Event of the specified type during the bubbling phase of event delivery.

    Example of handling mouse events

    pane.handleEvent(MouseEvent.Any) {
      me: MouseEvent => {
        me.eventType match {
          case MouseEvent.MousePressed => ...
          case MouseEvent.MouseDragged => ...
          case _                       => {}
        }
      }
    }

    or

    pane.handleEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
    J

    type JavaFX delegate of the event

    S

    ScalaFX type for J type wrapper.

    eventType

    type of events that will be handled.

    handler

    code handling the event, see examples above.

    returns

    Returns a subscription that can be used to cancel/remove this event handler

    Definition Classes
    EventHandlerDelegate1
  37. def hasProperties: Boolean

    Tests if this TableColumnBase has properties.

    Tests if this TableColumnBase has properties.

    Definition Classes
    TableColumnBase
  38. def hashCode(): Int

    returns

    The delegate hashcode

    Definition Classes
    SFXDelegate → AnyRef → Any
  39. def id: StringProperty

    The id of this TableColumnBase.

    The id of this TableColumnBase.

    Definition Classes
    TableColumnBase
  40. def id_=(v: String): Unit
    Definition Classes
    TableColumnBase
  41. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  42. def maxWidth: DoubleProperty

    The maximum width the TableColumnBase is permitted to be resized to.

    The maximum width the TableColumnBase is permitted to be resized to.

    Definition Classes
    TableColumnBase
  43. def maxWidth_=(v: Double): Unit
    Definition Classes
    TableColumnBase
  44. def minWidth: DoubleProperty

    The minimum width the TableColumnBase is permitted to be resized to.

    The minimum width the TableColumnBase is permitted to be resized to.

    Definition Classes
    TableColumnBase
  45. def minWidth_=(v: Double): Unit
    Definition Classes
    TableColumnBase
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  49. def onEditCancel: ObjectProperty[EventHandler[CellEditEvent[S, T]]]

    This event handler will be fired when the user cancels editing a cell.

  50. def onEditCancel_=(v: EventHandler[CellEditEvent[S, T]]): Unit
  51. def onEditCommit: ObjectProperty[EventHandler[CellEditEvent[S, T]]]

    This event handler will be fired when the user successfully commits their editing.

  52. def onEditCommit_=(v: EventHandler[CellEditEvent[S, T]]): Unit
  53. def onEditStart: ObjectProperty[EventHandler[CellEditEvent[S, T]]]

    This event handler will be fired when the user successfully initiates editing.

  54. def onEditStart_=(v: EventHandler[CellEditEvent[S, T]]): Unit
  55. def parentColumn: ReadOnlyObjectProperty[javafx.scene.control.TableColumnBase[S, _]]

    This read-only property will always refer to the parent of this column, in the situation where nested columns are being used.

    This read-only property will always refer to the parent of this column, in the situation where nested columns are being used.

    Definition Classes
    TableColumnBase
  56. def prefWidth: DoubleProperty

    The preferred width of the TableColumnBase.

    The preferred width of the TableColumnBase.

    Definition Classes
    TableColumnBase
  57. def prefWidth_=(v: Double): Unit
    Definition Classes
    TableColumnBase
  58. def pseudoClassStates: ObservableSet[PseudoClass]

    The pseudo-class state of this Styleable.

    The pseudo-class state of this Styleable.

    Definition Classes
    Styleable
  59. def removeEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[E]): Unit

    Unregisters a previously registered event filter from this task.

    Unregisters a previously registered event filter from this task. One filter might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the filter.

    E

    Event class

    eventType

    the event type from which to unregister

    eventHandler

    the filter to unregister

    Definition Classes
    EventHandlerDelegate1
  60. def removeEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[E]): Unit

    Unregisters a previously registered event handler from this task.

    Unregisters a previously registered event handler from this task. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.

    E

    Event class

    eventType

    the event type from which to unregister

    eventHandler

    the handler to unregister

    Definition Classes
    EventHandlerDelegate1
  61. def resizable: BooleanProperty

    Used to indicate whether the width of this column can change.

    Used to indicate whether the width of this column can change.

    Definition Classes
    TableColumnBase
  62. def resizable_=(v: Boolean): Unit
    Definition Classes
    TableColumnBase
  63. def sortNode: ObjectProperty[javafx.scene.Node]

    The sort node is commonly seen represented as a triangle that rotates on screen to indicate whether the TableColumnBase is part of the sort order, and if so, what position in the sort order it is in.

    The sort node is commonly seen represented as a triangle that rotates on screen to indicate whether the TableColumnBase is part of the sort order, and if so, what position in the sort order it is in.

    Definition Classes
    TableColumnBase
  64. def sortNode_=(v: Node): Unit
    Definition Classes
    TableColumnBase
  65. def sortType: ObjectProperty[SortType]

    Used to state whether this column, if it is part of the TableView.sortOrder ObservableList, should be sorted in ascending or descending order.

  66. def sortType_=(v: SortType): Unit
  67. def sortable: BooleanProperty

    A boolean property to toggle on and off the sortability of this column.

    A boolean property to toggle on and off the sortability of this column.

    Definition Classes
    TableColumnBase
  68. def sortable_=(v: Boolean): Unit
    Definition Classes
    TableColumnBase
  69. def style: StringProperty

    The CSS style string associated to this TableColumnBase.

    The CSS style string associated to this TableColumnBase.

    Definition Classes
    TableColumnBase
  70. def styleClass: ObservableBuffer[String]

    A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.

    A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.

    Definition Classes
    Styleable
  71. def style_=(v: String): Unit
    Definition Classes
    TableColumnBase
  72. def styleableNode: Node

    Returns the Node that represents this Styleable object.

    Returns the Node that represents this Styleable object. This method should be overridden in cases where the Styleable is not itself a Node, so that it may optionally return the relevant root node representation of itself. By default this method returns null, which can mean that either the Styleable itself is a Node, or if that is not the case, that the Styleable does not have a node representation available at the time of request.

    returns

    the Node that represents this Styleable object

    Definition Classes
    Styleable
    Since

    9

  73. def styleableParent: Styleable

    The parent of this Styleable, or null if there is no parent.

    The parent of this Styleable, or null if there is no parent.

    Definition Classes
    Styleable
  74. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  75. def tableView: ReadOnlyObjectProperty[javafx.scene.control.TableView[S]]

    The TableView that this TableColumn belongs to.

  76. def text: StringProperty

    This is the text to show in the header for this column.

    This is the text to show in the header for this column.

    Definition Classes
    TableColumnBase
  77. def text_=(v: String): Unit
    Definition Classes
    TableColumnBase
  78. def toString(): String

    returns

    Returns the original delegate's toString() adding a [SFX] prefix.

    Definition Classes
    SFXDelegate → AnyRef → Any
  79. def typeSelector: String

    The type of this Styleable that is to be used in selector matching.

    The type of this Styleable that is to be used in selector matching.

    Definition Classes
    Styleable
  80. def userData: AnyRef

    Returns a previously set Object property, or null if no such property has been set using the setUserData(Any) method.

    Returns a previously set Object property, or null if no such property has been set using the setUserData(Any) method.

    Definition Classes
    TableColumnBase
  81. def visible: BooleanProperty

    Toggling this will immediately toggle the visibility of this column, and all children columns.

    Toggling this will immediately toggle the visibility of this column, and all children columns.

    Definition Classes
    TableColumnBase
  82. def visible_=(v: Boolean): Unit
    Definition Classes
    TableColumnBase
  83. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  84. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  85. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  86. def width: ReadOnlyDoubleProperty

    The width of this column.

    The width of this column.

    Definition Classes
    TableColumnBase

Deprecated Value Members

  1. def cellFactory_=(f: (TableColumn[S, T]) => TableCell[S, T]): Unit
    Annotations
    @deprecated
    Deprecated

    (Since version 16.0.0-R25) This method does not allow for correct handling of empty cells leading to possible rendering artifacts. See explanation in ScalaFX Issue #256. Use the new cellFactory assignment method: cellFactory_=(op: (TableCell[S, T], T) => Unit) that automatically handles empty cells.

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from TableColumnBase[S, T]

Inherited from Styleable

Inherited from SFXDelegate[javafx.scene.control.TableColumn[S, T]]

Inherited from EventHandlerDelegate1

Inherited from AnyRef

Inherited from Any

Ungrouped