Roles
| Control | Windows | Mac | Notes | |
|---|---|---|---|---|
BUTTON | Button | X | X | |
CHECK_BOX | CheckBox | X | X | |
| CHECK_MENU_ITEM | CheckMenuItem | X | X | |
COMBO_BOX | ChoiceBox, ComboBox | X | X | |
CONTEXT_MENU | ContextMenu | X | X | |
DATE_PICKER | DatePicker | X | X | |
DECREMENT_BUTTON | ScrollBar, Spinner(skin) | X | X | |
HEADER | Table(skin), TreeTable(skin) | - | X | Mac needs to see the header Need to document what happens when the header is not set and/or ask for the header on Windows and fail if not there to avoid platform specific code. |
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_BAR | ToolBar | X | X | |
TOOLTIP | Tooltip | - | X | 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_ROW | TreeTableRow | X | X | |
TREE_TABLE_VIEW | TreeTableView | X | X | |
TREE_VIEW | TreeView | X | X |
Attributes
| Arg Count | Type | Used by | Windows | Mac | Notification | Notes | |
|---|---|---|---|---|---|---|---|
ACCELERATOR | 0 | 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 | boolean | Node, MenuItems | X | X | ||
DISCLOSURE_LEVEL | 0 | int | TreeView, TreeTableView | - | X | ||
EDITABLE | 0 | boolean | ComboBox | 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 | 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) | How is this used? | |
HEADER | 0 | Node | TableView, TreeTableView | ||||
| HELP | 0 | String | 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 | ||
MENU | 0 | Node | Menu | - | X | This is Mac specific and confusing. How is it used? | |
MENU_FOR | 0 | Node | Menu | - | X | 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 | ||
PAGES | 0 | ObservableList<Node> | Pagination | - | X | ||
PARENT | 0 | Parent | Node | X | X | ||
ROLE | 0 | Role | Node | X | X | ||
| ROLE_DESCRIPTION | 0 | String | Custom Controls | X | X | ||
ROW_AT_INDEX | 1 | Node, (int) | ListView, 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 | ||
ROW_INDEX | 0 | int | TableCell, TreeTableCell | X | X | ||
SCENE | 0 | Scene | Node, Scene | X | X | Y | |
SELECTED | 0 | boolean | CheckBox, ListView, RadioButton, TableView, ToggleButton, TreeView, TreeTableView, Pagination, TabPane, Menu | X | X | Y (Windows only) | |
SELECTED_ITEMS | 0 | ObservableList<Node> | ListView, TableView, TreeView, TreeTableView | X | X | ||
SELECTION_END | 0 | int | ComboBox, TextField, TextArea, Text | X | X | Y | |
SELECTION_START | 0 | int | ComboBox, TextField, TextArea, Text | X | X | Y | |
TABS | 0 | ObservableList<Node> | TabPane | - | X | ||
TITLE | 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 | Windows | Mac | |
|---|---|---|---|---|
BLOCK_DECREMENT | 0 | ScrollBar | X | - |
BLOCK_INCREMENT | 0 | ScrollBar | X | - |
COLLAPSE | 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 |
MOVE | 0 | ScrollBar, Slider | 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_TITLE | 1 (String) | TextField, TextArea | X | - |
SET_VALUE | 1 (double) | ScrollBar, Slider | X | - |
SHOW_MENU | 0 | Control, Menu, ToolBar | - | X |
Overview
Content Tools
ThemeBuilder