com.partnersoft.preferences.model

Class MapsetPreferences

java.lang.Object

com.partnersoft.preferences.model.AbstractSubsystemPreferences

com.partnersoft.preferences.model.MapsetPreferences

All Implemented Interfaces:

Coggable, SubsystemPreferences

public class MapsetPreferences
extends AbstractSubsystemPreferences

SubsystemPreferences for map control behavior.

Copyright 2010 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
MapsetPreferences()
MapsetPreferences(boolean loaded)
MapsetPreferences(boolean loaded, MapsetStartupVisibility visibilityAtStartup, boolean refreshedAtStartup)
MapsetPreferences(Cog state)

Method Summary

Methods

Modifier and Type	Method and Description
Duration	getAutoRefreshInterval() Interval to use for automatic refresh, if checked.
MapsetStartupVisibility	getVisibilityAtStartup() How to set visibility for this mapset at startup time.
boolean	isAutoRefreshed() If true, mapset is automatically refreshed, at an interval set by the autoRefreshInterval property.
boolean	isHiddenAtStartup()
boolean	isLoaded() If true, mapset is loaded at Map Viewer startup.
boolean	isRefreshedAtStartup() If true, mapset is refreshed at startup (assuming it is both visible and dynamic).
boolean	isRememberedAtStartup()
boolean	isVisibleAtStartup()
void	setAutoRefreshed(boolean autoRefreshed)
void	setAutoRefreshInterval(Duration autoRefreshInterval)
void	setLoaded(boolean loaded)
void	setRefreshedAtStartup(boolean refreshedAtStartup)
void	setVisibilityAtStartup(MapsetStartupVisibility visibilityAtStartup)
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

MapsetPreferences

public MapsetPreferences()

MapsetPreferences

public MapsetPreferences(boolean loaded)

MapsetPreferences

public MapsetPreferences(boolean loaded,
                 MapsetStartupVisibility visibilityAtStartup,
                 boolean refreshedAtStartup)

MapsetPreferences

public MapsetPreferences(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

isLoaded

public boolean isLoaded()

If true, mapset is loaded at Map Viewer startup.

setLoaded

public void setLoaded(boolean loaded)

isAutoRefreshed

public boolean isAutoRefreshed()

If true, mapset is automatically refreshed, at an interval set by the autoRefreshInterval property.

setAutoRefreshed

public void setAutoRefreshed(boolean autoRefreshed)

getAutoRefreshInterval

public Duration getAutoRefreshInterval()

Interval to use for automatic refresh, if checked.

setAutoRefreshInterval

public void setAutoRefreshInterval(Duration autoRefreshInterval)

isRefreshedAtStartup

public boolean isRefreshedAtStartup()

If true, mapset is refreshed at startup (assuming it is both visible and dynamic).

setRefreshedAtStartup

public void setRefreshedAtStartup(boolean refreshedAtStartup)

getVisibilityAtStartup

public MapsetStartupVisibility getVisibilityAtStartup()

How to set visibility for this mapset at startup time.

setVisibilityAtStartup

public void setVisibilityAtStartup(MapsetStartupVisibility visibilityAtStartup)

isVisibleAtStartup

public boolean isVisibleAtStartup()

isHiddenAtStartup

public boolean isHiddenAtStartup()

isRememberedAtStartup

public boolean isRememberedAtStartup()