javafx.scene.AccessibleAction Maven / Gradle / Ivy
/*
* Copyright (c) 2014, 2017, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javafx.scene;
/**
* This enum describes the actions that an assistive technology
* such as a screen reader can request from the scene graph.
*
* The {@link 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.
*
*
* @see Node#executeAccessibleAction(AccessibleAction, Object...)
* @see AccessibleRole
* @see AccessibleAttribute#ROLE
*
* @since JavaFX 8u40
*/
public enum AccessibleAction {
/**
* Request that the node be decremented by a large value.
* A smaller decrement is requested using {@link #DECREMENT}.
* Used by Slider, ScrollBar, and others
*/
BLOCK_DECREMENT,
/**
* Request that the node be incremented by a large value.
* A smaller increment is requested using {@link #INCREMENT}.
* Used by Slider, ScrollBar, and others
*/
BLOCK_INCREMENT,
/**
* Request that the node should become collapsed.
* Used by TreeItem, TitledPane, and others
*/
COLLAPSE,
/**
* Request that the node be decremented by a small value.
* A larger decrement is requested using {@link #BLOCK_DECREMENT}.
* Used by Slider, ScrollBar, and others
*/
DECREMENT,
/**
* Request that the node should become expanded.
* Used by TreeItem, TitledPane, and others
*/
EXPAND,
/**
* 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
*/
FIRE,
/**
* Request that the node be incremented by a small value.
* A larger increment is requested using {@link #BLOCK_INCREMENT}.
* Used by Slider, ScrollBar, and others
*/
INCREMENT,
/**
* Request that the node take focus. By default, a node will
* request focus using {@link 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
*/
REQUEST_FOCUS,
/**
* Request the node to show an item, scrolling if required.
* Used by ListView, TreeView, and others
*
* Parameters:
*
* - {@link Node} the item to show
*
*/
SHOW_ITEM,
/**
* Request the node to show a text range, scrolling if required.
* Used by TextField and TextArea.
*
* Parameters:
*
* - {@link java.lang.Integer} the start offset
* - {@link java.lang.Integer} the end offset
*
*/
SHOW_TEXT_RANGE,
/**
* Request the node to set the selection to a list of items.
* Used by ListView, TreeView, and others
*
* Parameters:
*
* - {@link javafx.collections.ObservableList}<{@link Node}> the items to select
*
*/
SET_SELECTED_ITEMS,
/**
* Request the node to set the selection to range of text.
* Used by TextField and TextArea.
*
* Parameters:
*
* - {@link java.lang.Integer} the start offset
* - {@link java.lang.Integer} the end offset
*
*/
SET_TEXT_SELECTION,
/**
* Request the node to set the current text.
* Used by TextField and TextArea.
*
* Parameters:
*
* - {@link String} the new text
*
*/
SET_TEXT,
/**
* Request the node to set the current value.
* Used by Slider, Scrollbars, and others
*
* Parameters:
*
* - {@link java.lang.Double} the new value
*
*/
SET_VALUE,
/**
* 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
*/
SHOW_MENU,
}