org.jpedal.examples.viewer.gui.javafx

Class JavaFXMenuItems

java.lang.Object

org.jpedal.examples.viewer.gui.generic.GUIMenuItems

org.jpedal.examples.viewer.gui.javafx.JavaFXMenuItems

public class JavaFXMenuItems
extends GUIMenuItems

This class controls everything to do with Menu Items, it holds the objects and their corresponding methods.

To initialise the object/class call init()

Field Summary

Fields inherited from class org.jpedal.examples.viewer.gui.generic.GUIMenuItems

currentCommandListener, includeExtraMenus, properties

Constructor Summary

Constructors

Constructor and Description
JavaFXMenuItems(PropertiesFile properties)

Method Summary

Modifier and Type	Method and Description
protected void	addMenuItem(javafx.scene.control.Menu parentMenu, String text, int ID)
protected void	addToMainMenu(javafx.scene.control.Menu fileMenuList) add MenuItem to main menu
void	addToMenu(Object menuItem, int parentMenuID) Add a menu item to a given menu bar
void	createMainMenu(boolean includeAll, CommandListener currentCommandListener, boolean isSingle, Values commonValues, Commands currentCommands, GUIButtons buttons) Not part of API - used internally
void	disableUnimplementedItems(int ID, boolean disableViewModes) Temporary Method to Disable unimplemented Viewer Items.
void	dispose() Method to dispose of objects used by the menu bar.
void	ensureNoSeperators() Remove separators from between menu items in File, Edit, View and Goto menuMap
void	ensureNoSeperators(int type) Not part of API - used internally
javafx.scene.control.MenuBar	getCurrentMenuFX() Get the MenuBar that holds the menu items
protected void	initLayoutMenus(javafx.scene.control.Menu pageLayout, String[] descriptions, int[] value, GUIButtons buttons, Commands currentCommands) sets up layout menu (controls page views - Multiple, facing,etc)
boolean	isMenuItemExist(int ID) Check if the given menu item has been created for the viewer
void	setBackNavigationItemsEnabled(boolean enabled) Method to enable or disable the back navigation menu items
void	setCheckMenuItemSelected(int ID, boolean b) Set the selected state of a check box style menu item.
void	setForwardNavigationItemsEnabled(boolean enabled) Method to enable or disable the forward navigation menu items
void	setGoToNavigationItemEnabled(boolean enabled) Method to enable or disable the goto menu items
void	setMenuItem(int ID, boolean enabled, boolean visible) Set the visibility or the enabled state of the menu or menu item specified by the id
void	setMenusForDisplayMode(int commandIDForDislayMode, int mouseMode) Sets various menu items as enabled or disabled and selects given values based on the display view.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaFXMenuItems

public JavaFXMenuItems(PropertiesFile properties)

Method Detail

getCurrentMenuFX

public javafx.scene.control.MenuBar getCurrentMenuFX()

Get the MenuBar that holds the menu items

Returns:

MenuBar used by this class

dispose

public void dispose()

Method to dispose of objects used by the menu bar.

Specified by:

dispose in class GUIMenuItems

setCheckMenuItemSelected

public void setCheckMenuItemSelected(int ID,
                                     boolean b)

Set the selected state of a check box style menu item.

Specified by:

setCheckMenuItemSelected in class GUIMenuItems

Parameters:

ID - int value for the menu items you wish to select

b - true to select the menu item, false to deselect

setBackNavigationItemsEnabled

public void setBackNavigationItemsEnabled(boolean enabled)

Method to enable or disable the back navigation menu items

Specified by:

setBackNavigationItemsEnabled in class GUIMenuItems

Parameters:

enabled - true to enable, false to disable

setForwardNavigationItemsEnabled

public void setForwardNavigationItemsEnabled(boolean enabled)

Method to enable or disable the forward navigation menu items

Specified by:

setForwardNavigationItemsEnabled in class GUIMenuItems

Parameters:

enabled - true to enable, false to disable

setGoToNavigationItemEnabled

public void setGoToNavigationItemEnabled(boolean enabled)

Method to enable or disable the goto menu items

Specified by:

setGoToNavigationItemEnabled in class GUIMenuItems

Parameters:

enabled - true to enable, false to disable

addMenuItem

protected void addMenuItem(javafx.scene.control.Menu parentMenu,
                           String text,
                           int ID)

initLayoutMenus

protected void initLayoutMenus(javafx.scene.control.Menu pageLayout,
                               String[] descriptions,
                               int[] value,
                               GUIButtons buttons,
                               Commands currentCommands)

sets up layout menu (controls page views - Multiple, facing,etc)

setMenusForDisplayMode

public void setMenusForDisplayMode(int commandIDForDislayMode,
                                   int mouseMode)

Sets various menu items as enabled or disabled and selects given values based on the display view.

Specified by:

setMenusForDisplayMode in class GUIMenuItems

Parameters:

commandIDForDislayMode - int value for the display view being used

mouseMode - int values for the mouse mode being used

addToMainMenu

protected void addToMainMenu(javafx.scene.control.Menu fileMenuList)

add MenuItem to main menu

createMainMenu

public void createMainMenu(boolean includeAll,
                           CommandListener currentCommandListener,
                           boolean isSingle,
                           Values commonValues,
                           Commands currentCommands,
                           GUIButtons buttons)

Not part of API - used internally

create items for menuMap on the menu bar

Specified by:

createMainMenu in class GUIMenuItems

ensureNoSeperators

public void ensureNoSeperators()

Remove separators from between menu items in File, Edit, View and Goto menuMap

Specified by:

ensureNoSeperators in class GUIMenuItems

ensureNoSeperators

public void ensureNoSeperators(int type)

Not part of API - used internally

Ensure no separators are present on the given MenuItem

Specified by:

ensureNoSeperators in class GUIMenuItems

Parameters:

type - int value for the menu bar to check

isMenuItemExist

public boolean isMenuItemExist(int ID)

Check if the given menu item has been created for the viewer

Specified by:

isMenuItemExist in class GUIMenuItems

Parameters:

ID - int value specifying a menu item

Returns:

true is menu item is present, false if not

setMenuItem

public void setMenuItem(int ID,
                        boolean enabled,
                        boolean visible)

Set the visibility or the enabled state of the menu or menu item specified by the id

Specified by:

setMenuItem in class GUIMenuItems

Parameters:

ID - int value specifying a menu item

enabled - true to enable the menu item, false to disable

visible - true to show the menu item, false to hide it

addToMenu

public void addToMenu(Object menuItem,
                      int parentMenuID)

Add a menu item to a given menu bar

Specified by:

addToMenu in class GUIMenuItems

Parameters:

menuItem - MenuItem to be add to the menu bar

parentMenuID - int value for the parent menu to add to

disableUnimplementedItems

public void disableUnimplementedItems(int ID,
                                      boolean disableViewModes)

Temporary Method to Disable unimplemented Viewer Items. Edit and Remove the items from this method as we implement features.