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

MenuItem

scalafx.scene.control.MenuItem
See theMenuItem companion object
class MenuItem(val delegate: MenuItem) extends EventTarget, Styleable, FireDelegate[MenuItem], SFXDelegate[MenuItem]

Attributes

Companion
object
Graph
Supertypes
trait FireDelegate[MenuItem]
trait Styleable
class EventTarget
trait SFXDelegate[MenuItem]
class Object
trait Matchable
class Any
Show all
Known subtypes
class Menu

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(text: String)

Constructs a MenuItem and sets the display text with the specified text

Constructs a MenuItem and sets the display text with the specified text

Attributes

def this(text: String, graphic: Node)

Constructor s MenuItem and sets the display text with the specified text and sets the graphic Node to the given node.

Constructor s MenuItem and sets the display text with the specified text and sets the graphic Node to the given node.

Attributes

Concrete methods

def accelerator: ObjectProperty[KeyCombination]

Attributes

def disable: BooleanProperty

Attributes

def graphic: ObjectProperty[Node]

Attributes

def graphic_=(v: Node): Unit
def id: StringProperty

Attributes

def id_=(v: String): Unit
def mnemonicParsing: BooleanProperty

MnemonicParsing property to enable/disable text parsing.

MnemonicParsing property to enable/disable text parsing.

Attributes

def onAction: ObjectProperty[EventHandler[ActionEvent]]

Attributes

def onAction_=(v: EventHandler[ActionEvent]): Unit
def onMenuValidation: ObjectProperty[EventHandler[Event]]

The event handler that is associated with invocation of an accelerator for a MenuItem. This can happen when a key sequence for an accelerator is pressed. The event handler is also invoked when onShowing event handler is called.

The event handler that is associated with invocation of an accelerator for a MenuItem. This can happen when a key sequence for an accelerator is pressed. The event handler is also invoked when onShowing event handler is called.

Attributes

Since

2.2

def onMenuValidation_=(eventHandler: EventHandler[Event]): Unit
def parentMenu: ReadOnlyObjectProperty[Menu]

Attributes

def parentPopup: ReadOnlyObjectProperty[ContextMenu]

Attributes

def properties: ObservableMap[AnyRef, AnyRef]

Returns an observable map of properties on this menu item for use primarily by application developers.

Returns an observable map of properties on this menu item for use primarily by application developers.

Attributes

def style: StringProperty

Attributes

def style_=(v: String): Unit
def text: StringProperty

Attributes

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(java.lang.Object) method.

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

Attributes

def userData_=(v: AnyRef): Unit
def visible: BooleanProperty

Attributes

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
def cssMetaData: Seq[CssMetaData[_ <: Styleable, _]]

The CssMetaData of this Styleable.

The CssMetaData of this Styleable.

Attributes

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 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 fire(): Unit

Fires some kind of event.

Fires some kind of event.

Attributes

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

Attributes

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.

Attributes

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 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
def pseudoClassStates: ObservableSet[PseudoClass]

The pseudo-class state of this Styleable.

The pseudo-class state of this Styleable.

Attributes

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

Attributes

Inherited from:
Styleable
def styleableNode: Node

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.

Attributes

Returns

the Node that represents this Styleable object

Since

9

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

Attributes

Inherited from:
Styleable
override def toString: String

Attributes

Returns

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

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

Attributes

Inherited from:
Styleable

Concrete fields

override val delegate: MenuItem

JavaFX object to be wrapped.

JavaFX object to be wrapped.

Attributes

Generated with