edu.utdallas.mavs.divas.visualization.vis3D.dialog

Class NiftyScreen<M extends MenuDialog,H extends HelpDialog>

java.lang.Object

edu.utdallas.mavs.divas.visualization.vis3D.dialog.NiftyScreen<M,H>

Type Parameters:

M -

H -

public class NiftyScreen<M extends MenuDialog,H extends HelpDialog>
extends java.lang.Object

This class describes a nifty screen.

Field Summary

Fields

Modifier and Type	Field and Description
BaseApplication<?,?>	app The JME application used for the 3D visualization of the simulation.
static de.lessvoid.nifty.elements.Element	helpPanelElement The parent element (layer) for the nifty help menu.
static de.lessvoid.nifty.elements.Element	menuLayerElement The parent element (layer) for the nifty menu.
de.lessvoid.nifty.Nifty	nifty The Nifty GUI used to render this screen.
de.lessvoid.nifty.screen.Screen	screen The current and only Screen in the Nifty GUI.
static de.lessvoid.nifty.elements.Element	windowLayerElement The parent Element (layer) for the nifty windows.

Constructor Summary

Constructors

Constructor and Description
NiftyScreen() The NiftyScreen constructor.

Method Summary

Modifier and Type	Method and Description
void	addContextWindow(java.lang.String id, AbstractPropertyDialog<?,?> dialog) Adds the dialog to the context window map.
boolean	contains(java.lang.String dialogId)
AbstractDialog<?>	getHelpDialog() Gets the help dialog.
static <M extends MenuDialog,H extends HelpDialog> NiftyScreen<?,?>	getInstance() This method returns the singleton instance of NiftyScreen.
AbstractDialog<?>	getMenuDialog() Gets the menu dialog.
void	hideAllElements() Hides all Nifty elements.
void	hideContextWindows() Hides all context windows.
void	removeAllContextWindows() Removes all context windows.
void	removeAllElements() Removes all Nifty elements.
void	removeContextWindow(java.lang.String id) Removes the Nifty element with the given id.
void	showContextWindows() Shows all context windows.
boolean	showElement(java.lang.String id) Shows the Nifty element for the given id.
void	showHide(AbstractDialog<?> dialog) If the given dialog is hidden this method shows it, otherwise hides it.
void	updateContextWindows() Updates the content of the context windows.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

app

public BaseApplication<?,?> app

The JME application used for the 3D visualization of the simulation.

nifty

public de.lessvoid.nifty.Nifty nifty

The Nifty GUI used to render this screen.

screen

public de.lessvoid.nifty.screen.Screen screen

The current and only Screen in the Nifty GUI. This element is the parent element for all other Nifty GUI elements.

windowLayerElement

public static de.lessvoid.nifty.elements.Element windowLayerElement

The parent Element (layer) for the nifty windows.

menuLayerElement

public static de.lessvoid.nifty.elements.Element menuLayerElement

The parent element (layer) for the nifty menu.

helpPanelElement

public static de.lessvoid.nifty.elements.Element helpPanelElement

The parent element (layer) for the nifty help menu.

Constructor Detail

NiftyScreen

public NiftyScreen()

The NiftyScreen constructor.

Method Detail

getInstance

public static <M extends MenuDialog,H extends HelpDialog> NiftyScreen<?,?> getInstance()

This method returns the singleton instance of NiftyScreen. If the instance is null, then the singleton instance is created.

Returns:

instance The Nifty Screen singleton instance.

showElement

public boolean showElement(java.lang.String id)

Shows the Nifty element for the given id.

Parameters:

id - The id of the element to show.

Returns:

false, if no element with the given id exits and true, if an element with the given id exists and was showed.

showContextWindows

public void showContextWindows()

Shows all context windows.

removeContextWindow

public void removeContextWindow(java.lang.String id)

Removes the Nifty element with the given id. The element is marked for removal and Nifty takes care of removing when it's ready.

Parameters:

id - The id of the element to be removed.

removeAllElements

public void removeAllElements()

Removes all Nifty elements. The elements are marked for removal and Nifty takes care of removing when it's ready.

removeAllContextWindows

public void removeAllContextWindows()

Removes all context windows. The elements are marked for removal and Nifty takes care of removing when it's ready.

hideAllElements

public void hideAllElements()

Hides all Nifty elements.

hideContextWindows

public void hideContextWindows()

Hides all context windows.

showHide

public void showHide(AbstractDialog<?> dialog)

If the given dialog is hidden this method shows it, otherwise hides it.

Parameters:

dialog - The dialog to be shown or hidden.

getHelpDialog

public AbstractDialog<?> getHelpDialog()

Gets the help dialog.

Returns:

The help dialog.

getMenuDialog

public AbstractDialog<?> getMenuDialog()

Gets the menu dialog.

Returns:

The menu dialog.

updateContextWindows

public void updateContextWindows()

Updates the content of the context windows.

addContextWindow

public void addContextWindow(java.lang.String id,
                             AbstractPropertyDialog<?,?> dialog)

Adds the dialog to the context window map.

Parameters:

id - The dialog id

dialog - The dialog instance

contains

public boolean contains(java.lang.String dialogId)

Parameters:

dialogId - The dialog id.

Returns:

true if the dialog is present in the context window map, otherwise returns false.