com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader Class Reference

Inheritance diagram for com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader:

Classes
enum	StandardLedWidgetStates
enum	StandardWifiWidgetStates

Public Member Functions
	JfxNavigationHeader (ScreenLayoutPersistence persistence)
void	initialiseUI (TreeComponentManager< Node > treeComponentManager, DialogManager dialogManager, MenuComponentControl control, ScrollPane managedNavArea)
Node	initialiseControls ()
void	setTitle (String newTitle)
void	addTitleWidget (TitleWidget< Image > widget)
void	addWidgetClickedListener (BiConsumer< ActionEvent, TitleWidget< Image >> listener)
DialogManager	getDialogManager ()
void	titleWidgetHasChanged (TitleWidget< Image > widget)
Optional< Button >	getButtonFor (TitleWidget< Image > widget)
void	pushMenuNavigation (SubMenuItem subMenuItem, boolean resetNavigation)
void	pushMenuNavigation (SubMenuItem asSubMenu)
void	pushNavigation (PanelPresentable< Node > navigation)
void	popNavigation ()
void	resetNavigationTo (PanelPresentable< Node > navigation)
PanelPresentable< Node >	currentNavigationPanel ()
void	setItemEditorPresenter (JfxPanelLayoutEditorPresenter panelPresenter)
void	addCustomMenuPanel (MenuItem theItem, PanelPresentable< Node > toPresent)
void	destroy ()
Public Member Functions inherited from com.thecoderscorner.embedcontrol.jfx.controlmgr.TitleWidgetListener< Image >
void	titleWidgetHasChanged (TitleWidget< T > widget)
Public Member Functions inherited from com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >
void	resetNavigationTo (PanelPresentable< T > navigation)
void	pushNavigation (PanelPresentable< T > navigation)
void	addTitleWidget (TitleWidget< I > titleWidget)

Static Public Member Functions
static TitleWidget< Image >	standardWifiWidget ()
static TitleWidget< Image >	standardSettingsWidget ()
static TitleWidget< Image >	standardSaveWidget ()
static TitleWidget< Image >	standardStatusLedWidget ()
static TitleWidget< Image >	standardLayoutWidget ()
static TitleWidget< Image >	widgetFromImages (URL... imageName)

---

Class Documentation

com::thecoderscorner::embedcontrol::jfx::controlmgr::JfxNavigationHeader::StandardLedWidgetStates

enum com::thecoderscorner::embedcontrol::jfx::controlmgr::JfxNavigationHeader::StandardLedWidgetStates

Enumerator
GREEN
ORANGE
RED

com::thecoderscorner::embedcontrol::jfx::controlmgr::JfxNavigationHeader::StandardWifiWidgetStates

enum com::thecoderscorner::embedcontrol::jfx::controlmgr::JfxNavigationHeader::StandardWifiWidgetStates

Enumerator
FAIR_SIGNAL
GOOD_SIGNAL
LOW_SIGNAL
MEDIUM_SIGNAL
NOT_CONNECTED

Member Function Documentation

addCustomMenuPanel()

void com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.addCustomMenuPanel	(	MenuItem	theItem,
		PanelPresentable< Node >	toPresent
	)

Allows the overriding of display panels on a per sub menu basis, for example you could provide custom UIs for a few panels and use the standard UIs for all the others. You provide a PanelPresentable implementation that will be called upon to be displayed when the submenu is on display. Associated UIs will be lazy created as needed.

Parameters

theItem	the sub menu item that has a custom panel
toPresent	the panel to be present when the submenu is selected.

Implements com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationManager.

addWidgetClickedListener()

void com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.addWidgetClickedListener

(

BiConsumer< ActionEvent, TitleWidget< Image >>

listener

)

Adds a listener that is informed when a title widget is clicked.

Parameters

listener

to be informed when a title widget is clicked in the UI

Implements com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.

currentNavigationPanel()

PanelPresentable<Node> com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.currentNavigationPanel

(

)

Gets the panel that is currently being displayed

Returns

the panel presentable that is being display

Implements com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.

getDialogManager()

DialogManager com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.getDialogManager

(

)

Get hold of the dialog manager instance that can present a simple one or two button dialog on the display, even remotely.

Implements com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.

popNavigation()

void com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.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.

Implements com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.

pushMenuNavigation() [1/2]

void com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.pushMenuNavigation

(

SubMenuItem

subMenuItem

)

Push a new submenu to be displayed, a shortcut for pushNavigation that prepares a new menu panel.

Parameters

subMenuItem

the submenu to present.

Implements com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.

pushMenuNavigation() [2/2]

void com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.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.

Parameters

subMenuItem	the submenu to present
resetNavigation	true to completely reset the navigation stack, otherwise false.

Implements com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.

setItemEditorPresenter()

void com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.setItemEditorPresenter

(

JfxPanelLayoutEditorPresenter

editorPresenter

)

When set puts any menus that are created into editable mode, so that the settings of each item can be overridden. Caution - calling this will completely reset navigation and reload the ROOT panel.

Parameters

editorPresenter

the editor presenter

Implements com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationManager.

setTitle()

void com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.setTitle

(

String

newTitle

)

Override the current title with the new title, by default the title is set during push/pop operations

Parameters

newTitle

the title text

Implements com.thecoderscorner.embedcontrol.core.controlmgr.NavigationManager< T, I >.

standardLayoutWidget()

static TitleWidget<Image> com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.standardLayoutWidget ( )

static

The standard widget for toggling between layout mode on and layout mode off, it has two images, image 1 is off and image 2 is on.

Returns

a widget that can represent layout mode being on and off.

standardSaveWidget()

static TitleWidget<Image> com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.standardSaveWidget ( )

static

Provides a single save icon that can be used in touch systems to perform a save operation.

Returns

a standard save widget

standardSettingsWidget()

static TitleWidget<Image> com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.standardSettingsWidget ( )

static

Creates a single icon that looks like a cog, suitable to represent a configuration widget.

Returns

the widget

standardStatusLedWidget()

static TitleWidget<Image> com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.standardStatusLedWidget ( )

static

Provides a standard tri-state LED arrangement with Red, Orange and Green in that order.

Returns

a tri-state LED widget

standardWifiWidget()

static TitleWidget<Image> com.thecoderscorner.embedcontrol.jfx.controlmgr.JfxNavigationHeader.standardWifiWidget ( )

static

Creates a 5 level WiFi widget that represents, no connection, poor connection, low strength, fair strength and a good connection. The first icon is no connection, the last is good connection.

Returns

the widget

---

The documentation for this class was generated from the following file:

• src/main/java/com/thecoderscorner/embedcontrol/jfx/controlmgr/JfxNavigationHeader.java