com.qoppa.pdfViewer

Class IconSettings

java.lang.Object

com.qoppa.pdfViewer.IconSettings

public class IconSettings
extends Object

This class encapsulates icon settings for the toolbars in PDFViewerBean.

It includes size settings for the toolbars for both standard and touch modes for PDFViewerBean, as well as control for enabling navigation buttons that show up on the pages when in touch mode.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static String	LARGE
static String	MEDIUM
static String	SMALL
static String	XLARGE

Constructor Summary

Constructors

Constructor and Description
IconSettings()

Method Summary

Methods

Modifier and Type	Method and Description
static void	enableTouchPageIcons(boolean enable) Enable/disable the navigation buttons on the page that are used in Touch Mode.
static String	getStandardIconSize() Returns a String representing the icon size for PDFViewerBean when in standard mode.
static String	getTouchIconSize() Returns a String representing the icon size for PDFViewerBean when in Touch Mode.
static void	setFromXML(String xmlString) This method sets the default IconSettings properties with a properly formatted String xml element.
static void	setStandardIconSize(String size) Sets the default icon size to use on toolbars in PDFViewerBean when in standard mode. The options are: IconSettings.SMALL: 16x16 icons except where noted in the icons readme.txt IconSettings.MEDIUM: 24x24 icons except where noted in the icons readme.txt (the default value) IconSettings.LARGE: 32x32 icons except where noted in the icons readme.txt IconSettings.XLARGE: 48x48 icons except where noted in the icons readme.txt
static void	setTouchIconSize(String size) Sets the default icon size to use on toolbars in PDFViewerBean when in Touch Mode. The options are: IconSettings.SMALL: 16x16 icons except where noted in the icons readme.txt IconSettings.MEDIUM: 24x24 icons except where noted in the icons readme.txt IconSettings.LARGE: 32x32 icons except where noted in the icons readme.txt IconSettings.XLARGE: 48x48 icons except where noted in the icons readme.txt (the default value)
static String	toXMLString() This method creates a String that contains an xml element of the default IconSettings properties.
static boolean	useTouchPageIcons() Returns true if the navigation buttons on the page that are used in Touch Mode are enabled.

Methods inherited from class java.lang.Object

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

Field Detail

SMALL

public static final String SMALL

See Also:

Constant Field Values

MEDIUM

public static final String MEDIUM

See Also:

Constant Field Values

LARGE

public static final String LARGE

See Also:

Constant Field Values

XLARGE

public static final String XLARGE

See Also:

Constant Field Values

Constructor Detail

IconSettings

public IconSettings()

Method Detail

setStandardIconSize

public static void setStandardIconSize(String size)

Sets the default icon size to use on toolbars in PDFViewerBean when in standard mode.
The options are:

• IconSettings.SMALL: 16x16 icons except where noted in the icons readme.txt
• IconSettings.MEDIUM: 24x24 icons except where noted in the icons readme.txt (the default value)
• IconSettings.LARGE: 32x32 icons except where noted in the icons readme.txt
• IconSettings.XLARGE: 48x48 icons except where noted in the icons readme.txt

Parameters:

size - one of the values listed above

getStandardIconSize

public static String getStandardIconSize()

Returns a String representing the icon size for PDFViewerBean when in standard mode.

Returns:

icon size

setTouchIconSize

public static void setTouchIconSize(String size)

Sets the default icon size to use on toolbars in PDFViewerBean when in Touch Mode.
The options are:

• IconSettings.SMALL: 16x16 icons except where noted in the icons readme.txt
• IconSettings.MEDIUM: 24x24 icons except where noted in the icons readme.txt
• IconSettings.LARGE: 32x32 icons except where noted in the icons readme.txt
• IconSettings.XLARGE: 48x48 icons except where noted in the icons readme.txt (the default value)

Parameters:

size - one of the values listed above

getTouchIconSize

public static String getTouchIconSize()

Returns a String representing the icon size for PDFViewerBean when in Touch Mode.

Returns:

icon size

enableTouchPageIcons

public static void enableTouchPageIcons(boolean enable)

Enable/disable the navigation buttons on the page that are used in Touch Mode.

Parameters:

enable -

useTouchPageIcons

public static boolean useTouchPageIcons()

Returns true if the navigation buttons on the page that are used in Touch Mode are enabled.

Returns:

enablement of touch page icons

toXMLString

public static String toXMLString()

This method creates a String that contains an xml element of the default IconSettings properties. This String can be stored and used to set the default IconSettings.

Returns:

A String containing an xml element of the IconSettings properties.

See Also:

setFromXML(String)

setFromXML

public static void setFromXML(String xmlString)

This method sets the default IconSettings properties with a properly formatted String xml element.

See Also:

toXMLString()