scalafx
API
Generated with
scalafx/scalafx/scalafx.scene/AccessibleAction

AccessibleAction

scalafx.scene.AccessibleAction
See theAccessibleAction companion class
object AccessibleAction extends SFXEnumDelegateCompanion[AccessibleAction, AccessibleAction]

This enum describes the actions that an assistive technology such as a screen reader can request from the scene graph.

The [[AccessibleRole]] dictates the set of actions that the screen reader will request for a particular control. For example, a push button normally fires an event to indicate that it was pressed in response to the FIRE action.

An action may have any number of parameters, depending on the particular action.

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/AccessibleAction.html

Attributes

Companion
class
Graph
Supertypes
trait Sum
trait Mirror
trait SFXEnumDelegateCompanion[AccessibleAction, AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

case object BlockDecrement extends AccessibleAction

Request that the node be decremented by a large value. A smaller decrement is requested using [[#DECREMENT]].

Request that the node be decremented by a large value. A smaller decrement is requested using [[#DECREMENT]].

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
case object BlockIncrement extends AccessibleAction

Request that the node be incremented by a large value. A smaller increment is requested using [[#INCREMENT]].

Request that the node be incremented by a large value. A smaller increment is requested using [[#INCREMENT]].

Used by Slider, ScrollBar, and others

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
case object Collapse extends AccessibleAction

Request that the node should become collapsed.

Request that the node should become collapsed.

Used by TreeItem, TitledPane, and others

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
Collapse.type
case object Decrement extends AccessibleAction

Request that the node be decremented by a small value. A larger decrement is requested using [[#BLOCK_DECREMENT]].

Request that the node be decremented by a small value. A larger decrement is requested using [[#BLOCK_DECREMENT]].

Used by Slider, ScrollBar, and others

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
Decrement.type
case object Expand extends AccessibleAction

Request that the node should become expanded.

Request that the node should become expanded.

Used by TreeItem, TitledPane, and others

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
Expand.type
case object Fire extends AccessibleAction

Fires the primary action for the node. For example, a push button will normally send an action event to notify listeners that is has been activated.

Fires the primary action for the node. For example, a push button will normally send an action event to notify listeners that is has been activated.

Used by Button, Hyperlink, and others

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
Fire.type
case object Increment extends AccessibleAction

Request that the node be incremented by a small value. A larger increment is requested using [[#BLOCK_INCREMENT]].

Request that the node be incremented by a small value. A larger increment is requested using [[#BLOCK_INCREMENT]].

Used by Slider, ScrollBar, and others

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
Increment.type
case object RequestFocus extends AccessibleAction

Request that the node take focus. By default, a node will request focus using [[javafx.scene.Node#requestFocus()]]. Both JavaFX and the assisteve technology have the concept of a focus node and most of the time, they are the same. In some cases, a control might want the JavaFX focus to remain on the parent, while the assistive technology focus is on the child. For example, a table may respond to this request by setting focus to a cell inside the table before allowing the default to run.

Request that the node take focus. By default, a node will request focus using [[javafx.scene.Node#requestFocus()]]. Both JavaFX and the assisteve technology have the concept of a focus node and most of the time, they are the same. In some cases, a control might want the JavaFX focus to remain on the parent, while the assistive technology focus is on the child. For example, a table may respond to this request by setting focus to a cell inside the table before allowing the default to run.

Used by Node, TabItem, TableCell and others

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
case object SetSelectedItems extends AccessibleAction

Request the node to set the selection to a list of items.

Request the node to set the selection to a list of items.

Used by ListView, TreeView, and others

Parameters:

  • [[javafx.collections.ObservableList]]<[[Node]]> the items to select

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
case object SetText extends AccessibleAction

Request the node to set the current text.

Request the node to set the current text.

Used by TextField and TextArea.

Parameters:

  • [[String]] the new text

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
SetText.type
case object SetTextSelection extends AccessibleAction

Request the node to set the selection to range of text.

Request the node to set the selection to range of text.

Used by TextField and TextArea.

Parameters:

  • [[java.lang.Integer]] the start offset

  • [[java.lang.Integer]] the end offset

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
case object SetValue extends AccessibleAction

Request the node to set the current value.

Request the node to set the current value.

Used by Slider, Scrollbars, and others

Parameters:

  • [[java.lang.Double]] the new value

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
SetValue.type
case object ShowItem extends AccessibleAction

Request the node to show an item, scrolling if required.

Request the node to show an item, scrolling if required.

Used by ListView, TreeView, and others

Parameters:

  • [[Node]] the item to show

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
ShowItem.type
case object ShowMenu extends AccessibleAction

Request the node to show a menu. If the node is a control, then the context menu for the control is shown. If the node is a menu, then the submenu for the menu is shown.

Request the node to show a menu. If the node is a control, then the context menu for the control is shown. If the node is a menu, then the submenu for the menu is shown.

Used by Node, Menu

Parameters:

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type
ShowMenu.type
case object ShowTextRange extends AccessibleAction

Request the node to show a text range, scrolling if required.

Request the node to show a text range, scrolling if required.

Used by TextField and TextArea.

Parameters:

  • [[java.lang.Integer]] the start offset

  • [[java.lang.Integer]] the end offset

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait SFXEnumDelegate[AccessibleAction]
trait SFXDelegate[AccessibleAction]
class Object
trait Matchable
class Any
Show all
Self type

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Inherited methods

def apply(e: AccessibleAction): S

Converts a JavaFX enum to its respective SFXEnumDelegate.

Converts a JavaFX enum to its respective SFXEnumDelegate.

Value parameters

e

JavaFX enum

Attributes

Returns

[[scalafx.delegate.SFXEnumDelegate]] equivalent to argument.

Inherited from:
SFXEnumDelegateCompanion
def apply(name: String): S

Returns the enum constant of this type with the specified name.

Returns the enum constant of this type with the specified name.

Value parameters

name

the name of the constant to return

Attributes

Throws
IllegalArgumentException

If the specified enum type has no constant with the specified name, or the specified class object does not represent an enum type.

Inherited from:
SFXEnumDelegateCompanion
def jfxEnum2sfx(e: AccessibleAction): S

Converts a JavaFX enum to its respective SFXEnumDelegate.

Converts a JavaFX enum to its respective SFXEnumDelegate.

Value parameters

e

JavaFX enum

Attributes

Returns

[[scalafx.delegate.SFXEnumDelegate]] equivalent to argument.

Inherited from:
SFXEnumDelegateCompanion

Inherited fields

lazy val values: List[AccessibleAction]

Returns a List containing the constants of this enum type, in the order they are declared.

Returns a List containing the constants of this enum type, in the order they are declared.

Attributes

Inherited from:
SFXEnumDelegateCompanion

Implicits

Inherited implicits

implicit def sfxEnum2jfx(s: AccessibleAction): E

Converts a SFXEnumDelegate to its respective JavaFX Enum.

Converts a SFXEnumDelegate to its respective JavaFX Enum.

Value parameters

s

SFXEnumDelegate instance

Attributes

Returns

Delegated enum

Inherited from:
SFXEnumDelegateCompanion
Generated with