embedCONTROLCore
Public Member Functions | |
| void | popNavigation () |
| void | resetNavigationTo (PanelPresentable< T > navigation) |
| void | pushNavigation (PanelPresentable< T > navigation) |
| void | pushMenuNavigation (SubMenuItem subMenuItem, boolean resetNavigation) |
| PanelPresentable< Node > | currentNavigationPanel () |
| void | setTitle (String newTitle) |
| void | addTitleWidget (TitleWidget< I > titleWidget) |
| void | addWidgetClickedListener (BiConsumer< ActionEvent, TitleWidget< Image >> listener) |
| void | pushMenuNavigation (SubMenuItem subMenuItem) |
| DialogManager | getDialogManager () |
Provides the core navigational capabilities within the app, it handles the stack of panels that have been presented and the ability to go backwards out of them using pop. It is also possible to reset the navigation back to a single panel. Title widgets are also managed by the navigation manager, where you can add widgets and also register for clicks on the widget's underlying button.
| <T> | The UI display type |
| <I> | The UI Image type required by title widgets |
| void com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.addTitleWidget | ( | TitleWidget< I > | titleWidget | ) |
Adds a title widget to the widgets displayed generally on the right hand side of the menu. On touch screen systems it is possible to interact with this and clicking one results in a clicked listener callback.
| titleWidget | the title widget to add |
| void com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.addWidgetClickedListener | ( | BiConsumer< ActionEvent, TitleWidget< Image >> | listener | ) |
Adds a listener that is informed when a title widget is clicked.
| listener | to be informed when a title widget is clicked in the UI |
Implemented in com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.
| PanelPresentable<Node> com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.currentNavigationPanel | ( | ) |
Gets the panel that is currently being displayed
Implemented in com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.
| DialogManager com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.getDialogManager | ( | ) |
Get hold of the dialog manager instance that can present a simple one or two button dialog on the display, even remotely.
Implemented in com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.
| void com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.popNavigation | ( | ) |
Go back one level in the navigation. Usually there is a back button that will control going back one level, it will be enabled whenever canClose returns true.
Implemented in com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.
| void com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.pushMenuNavigation | ( | SubMenuItem | subMenuItem | ) |
Push a new submenu to be displayed, a shortcut for pushNavigation that prepares a new menu panel.
| subMenuItem | the submenu to present. |
Implemented in com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.
| void com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.pushMenuNavigation | ( | SubMenuItem | subMenuItem, |
| boolean | resetNavigation | ||
| ) |
Push a new menu onto the display with the option to reset the layout at the same time by passing true as the second parameter.
| subMenuItem | the submenu to present |
| resetNavigation | true to completely reset the navigation stack, otherwise false. |
Implemented in com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.
| void com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.pushNavigation | ( | PanelPresentable< T > | navigation | ) |
Push a new item onto the navigation queue, so that the panel is displayed and at the top of the stack.
| navigation | the navigation item to add |
| void com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.resetNavigationTo | ( | PanelPresentable< T > | navigation | ) |
Reset the navigation stack to just this single item, removing all other items from the list.
| navigation | the navigation item to switch to. |
| void com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.setTitle | ( | String | newTitle | ) |
Override the current title with the new title, by default the title is set during push/pop operations
| newTitle | the title text |
Implemented in com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.