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
static String	XMLKEY_ICON_SETTINGS

Constructor Summary

Constructors

Constructor and Description
IconSettings()

Method Summary

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	getCommentsPanelStandardIconSize() Returns a String representing the icon size for the comments panel in PDFViewerBean when in standard mode.
static String	getCommentsPanelTouchIconSize() Returns a String representing the icon size for the comments panel in PDFViewerBean when in Touch Mode.
static String	getStandardIconSize() Returns a String representing the icon size for the toolbars PDFViewerBean when in standard mode.
static String	getTouchIconSize() Returns a String representing the icon size for the toolbars PDFViewerBean when in Touch Mode.
static void	setCommentsPanelStandardIconSize(String size) Sets the default icon size to use in the comments panel in PDFViewerBean when in standard mode. The size should be of format "32x32", or for convenience, you can use one of the following constants IconSettings.SMALL: 16x16 icons IconSettings.MEDIUM: 24x24 icons IconSettings.LARGE: 32x32 icons IconSettings.XLARGE: 48x48 icons
static void	setCommentsPanelTouchIconSize(String size) Sets the default icon size to use in the comments panel in PDFViewerBean when in Touch Mode. The size should be of format "32x32", or for convenience, you can use one of the following constants IconSettings.SMALL: 16x16 icons IconSettings.MEDIUM: 24x24 icons IconSettings.LARGE: 32x32 icons IconSettings.XLARGE: 48x48 icons
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 size should be of format "32x32", or for convenience, you can use one of the following constants IconSettings.SMALL: 16x16 icons IconSettings.MEDIUM: 24x24 icons IconSettings.LARGE: 32x32 icons IconSettings.XLARGE: 48x48 icons
static void	setTouchIconSize(String size) Sets the default icon size to use on toolbars in PDFViewerBean when in Touch Mode. The size should be of format "32x32", or for convenience, you can use one of the following constants: IconSettings.SMALL: 16x16 icons IconSettings.MEDIUM: 24x24 icons IconSettings.LARGE: 32x32 icons IconSettings.XLARGE: 48x48 icons
static void	setUseIconsOnTabButtons(boolean useIcons) Toggle whether tab buttons should be representing by icons or text
static String	toXMLString() This method creates a String that contains an xml element of the default IconSettings properties.
static boolean	useIconsOnTabButtons() Returns true if the tab buttons are represented by icons, text otherwise.
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

XMLKEY_ICON_SETTINGS

public static final String XMLKEY_ICON_SETTINGS

See Also:

Constant Field Values

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 size should be of format "32x32", or for convenience, you can use one of the following constants

• IconSettings.SMALL: 16x16 icons
• IconSettings.MEDIUM: 24x24 icons
• IconSettings.LARGE: 32x32 icons
• IconSettings.XLARGE: 48x48 icons

Parameters:

size - icon size of the format "32x32" (use multiples of 16 for best results)

getStandardIconSize

public static String getStandardIconSize()

Returns a String representing the icon size for the toolbars 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 size should be of format "32x32", or for convenience, you can use one of the following constants:

• IconSettings.SMALL: 16x16 icons
• IconSettings.MEDIUM: 24x24 icons
• IconSettings.LARGE: 32x32 icons
• IconSettings.XLARGE: 48x48 icons

Parameters:

size - icon size of the format "32x32" (use multiples of 16 for best results)

getTouchIconSize

public static String getTouchIconSize()

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

Returns:

icon size

setCommentsPanelStandardIconSize

public static void setCommentsPanelStandardIconSize(String size)

Sets the default icon size to use in the comments panel in PDFViewerBean when in standard mode.
The size should be of format "32x32", or for convenience, you can use one of the following constants

• IconSettings.SMALL: 16x16 icons
• IconSettings.MEDIUM: 24x24 icons
• IconSettings.LARGE: 32x32 icons
• IconSettings.XLARGE: 48x48 icons

Parameters:

size - icon size of the format "32x32" (use multiples of 16 for best results)

getCommentsPanelStandardIconSize

public static String getCommentsPanelStandardIconSize()

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

Returns:

icon size

setCommentsPanelTouchIconSize

public static void setCommentsPanelTouchIconSize(String size)

Sets the default icon size to use in the comments panel in PDFViewerBean when in Touch Mode.
The size should be of format "32x32", or for convenience, you can use one of the following constants

• IconSettings.SMALL: 16x16 icons
• IconSettings.MEDIUM: 24x24 icons
• IconSettings.LARGE: 32x32 icons
• IconSettings.XLARGE: 48x48 icons

Parameters:

size - icon size of the format "32x32" (use multiples of 16 for best results)

getCommentsPanelTouchIconSize

public static String getCommentsPanelTouchIconSize()

Returns a String representing the icon size for the comments panel in 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

setUseIconsOnTabButtons

public static void setUseIconsOnTabButtons(boolean useIcons)

Toggle whether tab buttons should be representing by icons or text

Parameters:

useIcons -

useIconsOnTabButtons

public static boolean useIconsOnTabButtons()

Returns true if the tab buttons are represented by icons, text otherwise.

Returns:

representation on tab buttons

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()