Page History

Roles

CONTEXT

	Control	Windows	Mac	Notes
BUTTON	Button	X		CHECKBOXX
CHECK_BOX	CheckBox	COMBOBOXX	X
CHECK_MENU_ITEM	CheckMenuItem	X	X		DATE_PICKER
COMBO_BOX	ChoiceBox, ComboBox	X	X
DECREMENTCONTEXT_BUTTONMENU	ContextMenu	X	X		DISCLOSURE_NODE
DATE_PICKER	DatePicker	X	X			HEADER
DECREMENT_BUTTON	ScrollBar, Spinner(skin)	X	X
HYPERLINK	Hyperlink	X	X
IMAGE_VIEW	ImageView	X	X
INCREMENT_BUTTON		ScrollBar, Spinner(skin)	X	X
LIST_ITEM	ListCell	X	X
LIST_VIEW	ListView	X	X
MENU	Menu	X	X
MENU_BAR	MenuBar	X	X
MENU_BUTTON	MenuButton	X	X
MENU_ITEM	MenuItem	X	X
NODE	Node	X	X
PAGE		_ITEM	IndicatorButton (in PaginationSkin)	X	X
PAGINATION	Pagination	X	X
PARENT		Parent, Scene	X	X
PASSWORD_FIELD	PasswordField	X	X
PROGRESS_INDICATOR	ProgressIndicator	X	X
RADIO_BUTTON	RadioButton	X	X
RADIO_MENU_ITEM	RadioMenuItem	X	X
SCROLL_BAR	ScrollBar	X	X
SCROLL_PANE	ScrollPane	X	X
SLIDER	Slider	X	X
SPINNER	Spinner	X	X
SPLIT_MENU_BUTTON	SplitMenuButton	X	X
TAB_ITEM			TabHeaderSkin (in TabPaneSkin)	X	X
TAB_PANE	TabPane	X	X
TABLE_CELL	TableCell	X	X
TABLE_COLUMN			TableView (TableColumnHeader)	X	X	Used by Mac & Win to find the column name. Win does not require native role.
TABLE_ROW	TableRow	X	X
TABLE_VIEW	TableView	X	X
TEXT	Text	X	X
TEXT_AREA	TextArea	X	X
TEXT_FIELD	TextField	X	X
THUMB	ScrollBar, Slider	X	X
TITLED_PANE	TitledPane	X	X
TOGGLE_BUTTON	ToggleButton	X	X
TOOL_BARTOOLBAR	ToolBar	X	X
TOOLTIP				Tooltip	-	X	RT-36992 This seems to be a work around for a Mac specific problem. When a window is shown, focus goes to the control inside (the text of the tooltip), then that hides the window, then the tooltip is show. Need to document that this is not asked for on Windows. I assume that using a TEXT role control for the tooltip guts works on Windows but fails on Mac? Is there another way that this could be worked around that did not require a platform specific role?
TREE_ITEM	TreeCell	X	X
TREE_TABLE_CELL	TreeTableCell	X	X
TREE_TABLE_ITEMROW	TreeTableRow	X	X
TREE_TABLE_VIEW	TreeTableView	X	X
TREE_VIEW	TreeView	X	X

Attributes

DESCRIPTION-

	Arg Count	Type	Used by	Windows	Mac	Notification	Notes
ACCELERATOR	00	KeyCombination	MenuItem	X	X (called 4 times)
BOUNDS	0	Bounds	Node	X (also used to compute scroll %)	X (called 2 times)
BOUNDS_FOR_RANGE	2	Bounds[], (int, int)	TextField, TextArea, Text	X	X		Bounds for each char in a range
CARET_OFFSET	0	int	TextField, TextArea, Text	-	X		Caret offset (line number?)
CELL_AT_ROW_COLUMN	2	Node, (int, int)	TableView, TreeTableView	X	X
CHILDREN	0	ObservableList<Node>	Parent, Scene	X (called to navigate)	X		When a control contains both "items" and children, does the CHILDREN return the complete list?
COLUMN_AT_INDEX	1	Node, (int)	TableView, TreeTableView	X	X
COLUMN_COUNT	0		TableView, TreeTableView	X	X
COLUMN_INDEX	0	int	TableCell, TreeTableCell	X	X
CONTENTS	0	Node	ScrollPane	X (used to compute scroll %)	X (how used?)
DATE	0	LocalDate	DatePicker	-	X (DatePicker)
DISABLED	0	String	boolean	Node, MenuItems	X	X
DISCLOSURE_LEVEL	0	int	TreeView, TreeTableView	-	X
EDITABLE	0	boolean	X	X		used in Combo only (what about editable text?)	ENABLED	0	booleanComboBox	X	X
EXPANDED	0	boolean	ChoiceBox, ComboBox, SplitMenuButton, TitledPan, TreeView, TreeTable	X	X	Y
FOCUS_ITEM	0	Node	ListView, TableView, TreeView, TreeTableView, TabPane, Pagination	X	X	Y (Mac only)	confusing (need to explain why needed?)
FOCUS_NODE	0	Node	Scene, MenuBar	X	X	Y
FOCUSED	0	boolean	Node			Y	explain how/why it is used/needed with the other focus properties
FONT	0	Font	TextField, TextArea, Text	X	X (called 3 times)		Font for a text run (why not a range, explain usage)		How is this used?
HEADER	0	Node	TableView, TreeTableView				Mac needs to see the header
HELP	0	String	HEADER	0	Node	X	X
HORIZONTAL_SCROLLBAR	0	Node	ListView, ScrollPane, TableView, TreeTableView, TreeView	X (used to scroll and compute %, isScrollable= bar is VISIBLE	X (how used?)
INDETERMINATE	0				boolean	CheckBox, ProgressIndicator	X (used by ToggleButton)	X (used by ToggleButton and ProgressIndicator)	Y (Windows only)
INDEX	0			int	ListView, TableView, TreeView, TreeTableView	X (use for SCROLL_TO_INDEX, index of LIST_ITEM)	X (TABLE_COLUMN, LIST_ITEM, TABLE_ROW, TREE_ITEM, TREE_TABLE_ITEM)
LABELED_BY	0	Node				Node	X (COMBO, TEXT_FIELD, TEXT_AREA can't be labled)	X	default is TITLE
LEAF	0			boolean	TreeView, TreeTableView	X	X
LINE_END	1	int, (int)	Text	X	X
LINE_FOR_OFFSET	1	int, (int)	Text	X	X
LINE_START	1	int, (int)	Text	X	X
MAX_VALUE	0			double	ProgressIndicator, ScrollBar, Slider	X	X
MENUSUBMENU	0	Node	Menu	-	X			This is Mac specific and confusing. How is it used?
PARENT_MENUMENU_FOR	0	Node	Menu	-	X		MENU_ITEM_TYPE	0					Y	This is Mac specific but seems to be sent to a menu to get the parent menu. Would PARENT_MENU be a better name?
MIN_VALUE	0				double	ProgressIndicator, ScrollBar, Slider	X	X
MNEMONIC	0			String	Menu, Label, MenuBar	X	-
MULTIPLE_SELECTION	0				boolean	ListView, TableView, TreeTableView, TreeView	X	-
NODE_AT_POINT	1	Node, (Point2D)	Scene	X	X
OFFSET_AT_POINT	1	int, (Point2D)		TextArea, TextField, Text	X	X
ORIENTATION	0				Orientation	ProgressBar, ScrollBar, Slider	-	X
OVERFLOW_BUTTON	0	Node	ToolBar	X	X
PAGESPARENT	0	Parent	Node	X	X
PARENTROLE	0	Role	Node	X	X
ROLE_DESCRIPTION	0	String	Custom Controls	X	X			ROW_AT_INDEX
ITEM_COUNT	0	Int	ListView, TabPane, Pagination	X	X	1	Node, (int)					ROW_COUNT	0
ITEM_AT_INDEX	1	Node	ListView, TabPane, Pagination	X	X
ROW_AT_INDEX	0
SCENE	0
	1	Node, (int)	TreeTableView, TreeView, TableView*	X	X		*It is in the doc for TableView but no implemented nor needed.
ROW_COUNT	0	int	ListView, TableView, TableTreeView, TreeView	X (also used in scrolling - getVerticalViewSize())	X	SELECTED	0
			SELECTED_CELLSROW_INDEX	0			int	TableCell, TreeTableCell	X	X
SELECTED_PAGESCENE	0	Scene	Node, Scene	X	X	Y
SELECTED_ROWS	0				boolean	CheckBox, ListView, RadioButton, TableView, ToggleButton, TreeView, TreeTableView, Pagination, TabPane, Menu	X	X	Y (Windows only)
SELECTED_TABITEMS	0	ObservableList<Node>	ListView, TableView, TreeView, TreeTableView	X	X
SELECTION_END	0					int	ComboBox, TextField, TextArea, Text	X	X	Y
SELECTION_START	0
TABS	0
TITLE	0
TOOLTIP	0
int	ComboBox, TextField, TextArea, Text	X	X	Y
TEXT	0	String	ChoiceBox, ComboBox, DatePicker, Label, ListView, Menu, MenuBar, Pagination, PasswordField, Scene, TabPane, TableView, TextField, TextArea, TitlePane, TreeView, TreeTableView, Text, Spinner (* check list)	X	X	Y
TREE_ITEM_AT_INDEX	1	Node, (int)	TreeItem, TreeTableRow	X	X
TREE_ITEM_COUNT	0			int	TreeItem, TreeTableRow	X	X
TREE_ITEM_PARENT	0	Node	TreeItem, TreeTableRow	X	X
VALUE	0	double			ScrollBar, Slider, ProgressIndicator,	X	X	Y (Windows only)
VERTICAL_SCROLLBAR	0				Node	ListView, ScrollPane, TableView, TreeTableView, TreeView	X (used to scroll and compute %, isScrollable= bar is VISIBLE	X (how used?)
VISIBLE	0				boolean	Node, Menu, ToolBar (overflow button)	X (only used for scroll bar visibility and expand/collapse?)	-	Y (Mac only)
VISITED	0	boolean	Hyperlink	-	X

Actions

	Args	Control		ADD_TO_SELECTION		Windows	Mac
BLOCK_DECREMENT	0	ScrollBar	X	-
BLOCK_INCREMENT	0	ScrollBar	X	-
COLLAPSE
DECREMENT
EXPAND
FIRE
INCREMENT
MOVE
REMOVE_FROM_SELECTION
SCROLL_TO_INDEX
SELECT
SET_TITLE
SET_VALUE
	0	ChoiceBox, ComboBox, SplitMenuButton, TitledPane, Tree, TreeTable	X	X
DECREMENT	0	ScrollBar, Slider, Spinner	X	X
EXPAND	0	ChoiceBox, ComboBox, SplitMenuButton, TitledPane, Tree, TreeTable	X	X
FIRE	0	Button (all kinds), ToolBar (items), Spinner (buttons), ScrollBar (thumb), ContextMenuContent (menu items)	X	X
INCREMENT	0	ScrollBar, Slider, Spinner	X	X
REQUEST_FOCUS	0	Node, TabItem, PageItem, ListItem, TableItem, TreeItem, TreeTableItem	X	X
SHOW_ITEM	1(Node)	ListView, TableView, TreeTableView, TreeView	X	-
SHOW_TEXT_RANGE	2(int,int)	TextField, TextArea	X	-
SET_SELECTED_ITEMS	1(list)	ListView, TableView, TreeTableView, TreeView	X	X
SET_TEXT_SELECTION	2(int,int)	TextField, TextArea	X	X
SET_TEXT	1 (String)	TextField, TextArea	X	-
SET_VALUE	1 (double)	ScrollBar, Slider	X	-
SHOW_MENU	0	Control, Menu, ToolBar	-	X	SHOW_MENU

Child pages

Versions Compared

Old Version 13

New Version Current

Key

Roles

Attributes

Actions