org.jpedal.examples.viewer.gui

Class GUIModifier

java.lang.Object

org.jpedal.examples.viewer.gui.GUIModifier

public class GUIModifier
extends Object

A class that handles modifying the the viewers GUI based on property values found in the properties files. This class has two public methods (Load and alterProperty) to allow you to do this.

Load allows you to pass in a PropertiesFile object from which we take the various GUI properties and set the GUI to match these options

AlterProperty allows you to specify a single property and the value you wish to change it to.

Be aware that there are some properties that will not update live and must be set before the GUI is created, in these cases it is recommended to set the value within the properties file instead of changing it manually.

Please note, this updates the GUI only, if you wish to alter the values that are stored within you properties.xml file you need to use the following method.

PropertiesFile.setValue(final String elementName, final String newValue)

Constructor Summary

Constructors

Constructor and Description
GUIModifier()

Method Summary

Modifier and Type	Method and Description
static void	alterProperty(String value, boolean set, GUIFactory currentGUI) The method alters a single property value related to the GUI.
static void	load(PropertiesFile properties, GUIFactory currentGUI) This method loads all GUI properties from a PropertiesFile object.

Methods inherited from class java.lang.Object

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

Constructor Detail

GUIModifier

public GUIModifier()

Method Detail

load

public static void load(PropertiesFile properties,
                        GUIFactory currentGUI)

This method loads all GUI properties from a PropertiesFile object.

Parameters:

properties - The PropertiesFile to load values from.

currentGUI - The GUI to have the properties loaded into.

alterProperty

public static void alterProperty(String value,
                                 boolean set,
                                 GUIFactory currentGUI)

The method alters a single property value related to the GUI.

Parameters:

value - Name of the property to be altered as a String.

set - The value you wish to set for the property as a boolean.

currentGUI - The GUI interface the property is applied to.