com.partnersoft.preferences.model

Class LayoutPreferences

java.lang.Object

com.partnersoft.preferences.model.AbstractSubsystemPreferences

com.partnersoft.preferences.model.LayoutPreferences

All Implemented Interfaces:

Coggable, SubsystemPreferences

public class LayoutPreferences
extends AbstractSubsystemPreferences

Preference settings controlling Map Viewer application layout and GUI behavior.

Copyright 2010 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
LayoutPreferences(Cog state)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAdvancedFeaturesEnabled()
java.lang.String	getLookAndFeel() Java Swing pluggable look-and-feel (PLAF) used throughout the GUI.
java.lang.String	getSkin() Overall layout used.
LayoutPosition	getToolbarPosition() Allows you to place a configurable tool bar in the main window.
boolean	isFloatingErrorDisplayEnabled() If true, log error and warning messages will appear in a transparent floating display over the map viewing area.
boolean	isFormFieldPopupEnabled() If true, form field popup keyboard helper dialogs are enabled.
boolean	isZoomSliderEnabled() Turns on a slider control for zooming, for environments that don't have scroll wheels or good right-mouse-button controls.
void	setAdvancedFeaturesEnabled(boolean advancedFeaturesEnabled)
void	setFloatingErrorDisplayEnabled(boolean floatingErrorDisplayEnabled)
void	setFormFieldPopupEnabled(boolean formFieldPopupEnabled)
void	setLookAndFeel(java.lang.String lookAndFeel)
void	setSkin(java.lang.String skin)
void	setToolbarPosition(LayoutPosition toolbarPosition)
void	setZoomSliderEnabled(boolean zoomSliderEnabled)
Cog	toCog() Returns the complete internal state of this object in the form of a Cog.

Methods inherited from class com.partnersoft.preferences.model.AbstractSubsystemPreferences

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutPreferences

public LayoutPreferences(Cog state)

Method Detail

toCog

public Cog toCog()

Description copied from interface: Coggable

Returns the complete internal state of this object in the form of a Cog.

Specified by:

toCog in interface Coggable

Overrides:

toCog in class AbstractSubsystemPreferences

Returns:

Cog representing the internal state of this object

getSkin

public java.lang.String getSkin()

Overall layout used. These are currently hard-coded but we may allow scriptable skinning in the future.

setSkin

public void setSkin(java.lang.String skin)

getLookAndFeel

public java.lang.String getLookAndFeel()

Java Swing pluggable look-and-feel (PLAF) used throughout the GUI.

setLookAndFeel

public void setLookAndFeel(java.lang.String lookAndFeel)

isFloatingErrorDisplayEnabled

public boolean isFloatingErrorDisplayEnabled()

If true, log error and warning messages will appear in a transparent floating display over the map viewing area. It looks similar to the "Star Wars" intro text and was inspired by similar features in video games.

setFloatingErrorDisplayEnabled

public void setFloatingErrorDisplayEnabled(boolean floatingErrorDisplayEnabled)

isFormFieldPopupEnabled

public boolean isFormFieldPopupEnabled()

If true, form field popup keyboard helper dialogs are enabled.

setFormFieldPopupEnabled

public void setFormFieldPopupEnabled(boolean formFieldPopupEnabled)

isZoomSliderEnabled

public boolean isZoomSliderEnabled()

Turns on a slider control for zooming, for environments that don't have scroll wheels or good right-mouse-button controls.

setZoomSliderEnabled

public void setZoomSliderEnabled(boolean zoomSliderEnabled)

getToolbarPosition

public LayoutPosition getToolbarPosition()

Allows you to place a configurable tool bar in the main window. "Hidden" means don't place it at all.

setToolbarPosition

public void setToolbarPosition(LayoutPosition toolbarPosition)

getAdvancedFeaturesEnabled

public boolean getAdvancedFeaturesEnabled()

setAdvancedFeaturesEnabled

public void setAdvancedFeaturesEnabled(boolean advancedFeaturesEnabled)