org.jpedal.examples.viewer.gui.javafx

Class JavaFXButtons

java.lang.Object

org.jpedal.examples.viewer.gui.javafx.JavaFXButtons

All Implemented Interfaces:

GUIButtons

public class JavaFXButtons
extends Object
implements GUIButtons

This class controls everything todo with GUIButtons, it holds the objects and their corresponding methods.

To initialise the object/class call init()

Constructor Summary

Constructors

Constructor and Description
JavaFXButtons()

Method Summary

Modifier and Type	Method and Description
void	addButton(int line, String toolTip, String path, int ID, GUIMenuItems fxMenuItems, GUIFactory currentGUI, CommandListener currentCommandListener, javafx.scene.control.ToolBar pagesToolBar, javafx.scene.control.ToolBar navToolBar)
void	alignLayoutMenuOption(int mode) Aligns the layout menu option to the current view mode
void	checkButtonSeparators() Ensure buttons separators only appear in their logical places based on buttons present.
void	disableUnimplementedItems(int ID) Temporary Method to Disable unimplemented Viewer Items.
void	dispose() Prepares all objects for the trash collector
GUIButton	getButton(int ID) Returns the button associated with the ID.
ArrayList<javafx.scene.control.CheckMenuItem>	getLayoutGroup() Getter for layoutGroup.
javafx.scene.control.ToolBar	getTopButtons() Get the tool bar used to display the viewers top button bar
void	hideRedundentNavButtons(GUIFactory currentGUI) When page changes make sure only relevant navigation buttons are displayed
void	init(boolean isSingle) Initialises the buttons
void	setBackNavigationButtonsEnabled(boolean flag) Enables or disables all the back navigation buttons.
void	setEnabled(boolean set) Set the buttons tool bar to be enabled or disabled
void	setForwardNavigationButtonsEnabled(boolean flag) Enables or disables all the forward navigation buttons.
void	setPageLayoutButtonsEnabled(boolean flag) Enables or disables all the page layout buttons.
static void	setupButtonStyle() setupButtonStyle is unsupported in OpenViewerFX
void	setVisible(boolean set) Set the buttons tool bar visibility

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaFXButtons

public JavaFXButtons()

Method Detail

init

public void init(boolean isSingle)

Initialises the buttons

Parameters:

isSingle - is of type boolean

getButton

public GUIButton getButton(int ID)

Returns the button associated with the ID.

Specified by:

getButton in interface GUIButtons

Parameters:

ID - int value specifying a button

Returns:

GUIButton object specified

dispose

public void dispose()

Prepares all objects for the trash collector

setBackNavigationButtonsEnabled

public void setBackNavigationButtonsEnabled(boolean flag)

Enables or disables all the back navigation buttons.

Specified by:

setBackNavigationButtonsEnabled in interface GUIButtons

Parameters:

flag - true to enable buttons, false to disable

setForwardNavigationButtonsEnabled

public void setForwardNavigationButtonsEnabled(boolean flag)

Enables or disables all the forward navigation buttons.

Specified by:

setForwardNavigationButtonsEnabled in interface GUIButtons

Parameters:

flag - true to enable buttons, false to disable

setPageLayoutButtonsEnabled

public void setPageLayoutButtonsEnabled(boolean flag)

Enables or disables all the page layout buttons.

Specified by:

setPageLayoutButtonsEnabled in interface GUIButtons

Parameters:

flag - true to enable buttons, false to disable

alignLayoutMenuOption

public void alignLayoutMenuOption(int mode)

Aligns the layout menu option to the current view mode

Specified by:

alignLayoutMenuOption in interface GUIButtons

Parameters:

mode - int value specifying the display view mode

getLayoutGroup

public ArrayList<javafx.scene.control.CheckMenuItem> getLayoutGroup()

Getter for layoutGroup.

Returns:

ButtonGroup object layoutGroup

checkButtonSeparators

public void checkButtonSeparators()

Ensure buttons separators only appear in their logical places based on buttons present.

Specified by:

checkButtonSeparators in interface GUIButtons

getTopButtons

public javafx.scene.control.ToolBar getTopButtons()

Get the tool bar used to display the viewers top button bar

Returns:

ToolBar used to hold the viewers buttons

addButton

public void addButton(int line,
                      String toolTip,
                      String path,
                      int ID,
                      GUIMenuItems fxMenuItems,
                      GUIFactory currentGUI,
                      CommandListener currentCommandListener,
                      javafx.scene.control.ToolBar pagesToolBar,
                      javafx.scene.control.ToolBar navToolBar)

hideRedundentNavButtons

public void hideRedundentNavButtons(GUIFactory currentGUI)

When page changes make sure only relevant navigation buttons are displayed

Specified by:

hideRedundentNavButtons in interface GUIButtons

Parameters:

currentGUI - The user interface used for the viewer

setupButtonStyle

public static void setupButtonStyle()

setupButtonStyle is unsupported in OpenViewerFX

setVisible

public void setVisible(boolean set)

Set the buttons tool bar visibility

Specified by:

setVisible in interface GUIButtons

Parameters:

set - true to make the tool bar and button visible, false to make invisible

setEnabled

public void setEnabled(boolean set)

Set the buttons tool bar to be enabled or disabled

Specified by:

setEnabled in interface GUIButtons

Parameters:

set - true to enable the tool bar, false to disable

disableUnimplementedItems

public void disableUnimplementedItems(int ID)

Temporary Method to Disable unimplemented Viewer Items. Edit and Remove the items from this method as we implement features. When all items have been implemented, do a search for and remove all instances of this method + the method itself.