scalafx
API
Generated with
scalafx/scalafx/scalafx.scene/scalafx.scene.control/TreeItem

TreeItem

scalafx.scene.control.TreeItem
See theTreeItem companion object
class TreeItem[T](val delegate: TreeItem[T]) extends EventTarget, SFXDelegate[TreeItem[T]]

Wraps javafx.scene.control.TreeItem class.

Attributes

Companion
object
Graph
Supertypes
class EventTarget
trait SFXDelegate[TreeItem[T]]
class Object
trait Matchable
class Any

Members list

Type members

Inherited classlikes

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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any

Value members

Constructors

def this(value: T)

Creates a TreeItem with the value property set to the provided object.

Creates a TreeItem with the value property set to the provided object.

Attributes

def this(value: T, graphic: Node)

Creates a TreeItem with the value property set to the provided object, and the graphic set to the provided Node.

Creates a TreeItem with the value property set to the provided object, and the graphic set to the provided Node.

Attributes

Concrete methods

def children: ObservableBuffer[TreeItem[T]]

The children of this TreeItem.

The children of this TreeItem.

Attributes

def children_=(items: Seq[TreeItem[T]]): Unit
def expanded: BooleanProperty

The expanded state of this TreeItem.

The expanded state of this TreeItem.

Attributes

def graphic: ObjectProperty[Node]

The node that is generally shown to the left of the value property.

The node that is generally shown to the left of the value property.

Attributes

def graphic_=(v: Node): Unit
def leaf: ReadOnlyBooleanProperty

Represents the TreeItem leaf property, which is true if the TreeItem has no children.

Represents the TreeItem leaf property, which is true if the TreeItem has no children.

Attributes

def nextSibling: TreeItem[T]

Returns the next sibling of the TreeItem.

Returns the next sibling of the TreeItem.

Attributes

def nextSibling(afterNode: TreeItem[T]): TreeItem[T]

Returns the next sibling after the given node.

Returns the next sibling after the given node.

Attributes

def parent: ReadOnlyObjectProperty[TreeItem[T]]

A property that represents the parent of this TreeItem.

A property that represents the parent of this TreeItem.

Attributes

def previousSibling: TreeItem[T]

Returns the previous sibling of the TreeItem.

Returns the previous sibling of the TreeItem.

Attributes

def previousSibling(afterNode: TreeItem[T]): TreeItem[T]

Returns the previous sibling previous the given node.

Returns the previous sibling previous the given node.

Attributes

def value: ObjectProperty[T]

A property representing the application-specific data contained within this TreeItem.

A property representing the application-specific data contained within this TreeItem.

Attributes

def value_=(v: T): Unit

Inherited methods

def buildEventDispatchChain(tail: EventDispatchChain): EventDispatchChain

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

In the case the event target is part of some hierarchy, the chain for it is usually built from event dispatchers collected from the root of the hierarchy to the event target.

The event dispatch chain is constructed by modifications to the provided initial event dispatch chain. The returned chain should have the initial chain at its end so the dispatchers should be prepended to the initial chain.

The caller shouldn't assume that the initial chain remains unchanged nor that the returned value will reference a different chain.

Value parameters

tail

the initial chain to build from

Attributes

Returns

the resulting event dispatch chain for this target

See also
Inherited from:
EventTarget
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 parameters

ref

Object to be compared.

Attributes

Returns

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

Definition Classes
SFXDelegate -> Any
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 parameters

J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value parameters

eventType

type of events that will be handled.

filter

code handling the event, see examples above.

Attributes

Inherited from:
EventTarget
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 parameters

J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value parameters

eventType

type of events that will be handled.

handler

code handling the event, see examples above.

Attributes

Returns

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

Inherited from:
EventTarget
override def hashCode: Int

Attributes

Returns

The delegate hashcode

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
override def toString: String

Attributes

Returns

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

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate

Concrete fields

override val delegate: TreeItem[T]

JavaFX object to be wrapped.

JavaFX object to be wrapped.

Attributes

Generated with