TableColumnBase

abstract class TableColumnBase[S, T] extends EventHandlerDelegate1 with Styleable with SFXDelegate[TableColumnBase[S, T]]
trait Styleable
trait SFXDelegate[TableColumnBase[S, T]]
class Object
trait Matchable
class Any
class TableColumn[S, T]
class TreeTableColumn[S, T]

Type members

Inherited classlikes

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

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
Inherited from
EventHandlerDelegate1
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"

Inherited from
EventHandlerDelegate1
sealed trait FilterMagnet[J <: Event, S <: SFXDelegate[J]]

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"

Inherited from
EventHandlerDelegate1
sealed trait HandlerMagnet[J <: Event, S <: SFXDelegate[J]]

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"

Inherited from
EventHandlerDelegate1

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"

Inherited from
EventHandlerDelegate1

Value members

Abstract methods

def columns: ObservableBuffer[_ <: TableColumnBase[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.

Concrete methods

def comparator: ObjectProperty[Comparator[T]]

Comparator function used when sorting this TableColumnBase.

Comparator function used when sorting this TableColumnBase.

def comparator_=(v: Ordering[T]): Unit
def contextMenu: ObjectProperty[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.

def contextMenu_=(v: ContextMenu): Unit

Specifies whether this TableColumnBase allows editing.

Specifies whether this TableColumnBase allows editing.

def editable_=(v: Boolean): Unit
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).

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.

The graphic in the TableColumnBase.

The graphic in the TableColumnBase.

def graphic_=(v: Node): Unit
def hasProperties: Boolean

Tests if this TableColumnBase has properties.

Tests if this TableColumnBase has properties.

The id of this TableColumnBase.

The id of this TableColumnBase.

def id_=(v: String): Unit

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

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

def maxWidth_=(v: Double): Unit

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

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

def minWidth_=(v: Double): Unit
def parentColumn: ReadOnlyObjectProperty[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.

The preferred width of the TableColumnBase.

The preferred width of the TableColumnBase.

def prefWidth_=(v: Double): Unit

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

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

def resizable_=(v: Boolean): Unit

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.

def sortNode_=(v: Node): Unit

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.

def sortable_=(v: Boolean): Unit

The CSS style string associated to this TableColumnBase.

The CSS style string associated to this TableColumnBase.

def style_=(v: String): Unit

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

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

def text_=(v: String): Unit
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.

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.

def visible_=(v: Boolean): Unit

The width of this column.

The width of this column.

Inherited methods

def addEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[E]): Unit

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

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

Type Params
E

Event class

Value Params
eventHandler

the filter to register that will filter event

eventType

the type of the events to receive by the filter

Inherited from
EventHandlerDelegate1
def addEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[E]): Unit

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the handler to register that will manipulate event

eventType

the type of the events to receive by the handler

Inherited from
EventHandlerDelegate1
def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

Construct an event dispatch chain for this target.

Construct an event dispatch chain for this target.

Inherited from
EventHandlerDelegate1
def cssMetaData: Seq[CssMetaData[_ <: Styleable, _]]

The CssMetaData of this Styleable.

The CssMetaData of this Styleable.

Inherited from
Styleable
override def equals(ref: Any): Boolean

Verifies if a object is equals to this delegate.

Verifies if a object is equals to this delegate.

Value Params
ref

Object to be compared.

Returns

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

Definition Classes
Inherited from
SFXDelegate
def filterEvent[J <: Event, S <: Event & SFXDelegate[J]](eventType: EventType[J])(filter: FilterMagnet[J, S]): Subscription

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

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") }
Type Params
J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value Params
eventType

type of events that will be handled.

filter

code handling the event, see examples above.

Inherited from
EventHandlerDelegate1
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.

Inherited from
Styleable
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.

Inherited from
Styleable
def handleEvent[J <: Event, S <: Event & SFXDelegate[J]](eventType: EventType[J])(handler: HandlerMagnet[J, S]): Subscription

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.

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") }
Type Params
J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value Params
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

Inherited from
EventHandlerDelegate1
override def hashCode: Int
Returns

The delegate hashcode

Definition Classes
Inherited from
SFXDelegate
def pseudoClassStates: ObservableSet[PseudoClass]

The pseudo-class state of this Styleable.

The pseudo-class state of this Styleable.

Inherited from
Styleable
def removeEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[E]): Unit

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the filter to unregister

eventType

the event type from which to unregister

Inherited from
EventHandlerDelegate1
def removeEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[E]): Unit

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the handler to unregister

eventType

the event type from which to unregister

Inherited from
EventHandlerDelegate1

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.

Inherited from
Styleable

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. 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

Since

9

Inherited from
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.

Inherited from
Styleable
override def toString: String
Returns

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

Definition Classes
Inherited from
SFXDelegate
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.

Inherited from
Styleable

Concrete fields

override val delegate: TableColumnBase[S, T]