Gridarta Editor
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings Class Referenceabstract

Abstract base class for PickmapSettings implementations. More...

+ Inheritance diagram for net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings:
+ Collaboration diagram for net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings:

Public Member Functions

void addPickmapSettingsListener (@NotNull final PickmapSettingsListener listener)
 Adds a PickmapSettingsListener to be notified about changes. More...
 
boolean isLocked ()
 Returns whether pickmaps are immutable. More...
 
void removePickmapSettingsListener (@NotNull final PickmapSettingsListener listener)
 Removes a PickmapSettingsListener to be notified about changes. More...
 
void setLocked (final boolean locked)
 Sets whether pickmaps are immutable. More...
 

Protected Member Functions

abstract boolean loadLocked ()
 Loads the default value for locked. More...
 
abstract void saveLocked (boolean locked)
 Saves the locked value. More...
 

Private Member Functions

void fireLockedChanged ()
 Informs all registered listeners that the immutable state has changed. More...
 

Private Attributes

final EventListenerList2< PickmapSettingsListener > listenerList = new EventListenerList2<>(PickmapSettingsListener.class)
 The MapViewSettingsListeners to inform of changes. More...
 
boolean locked = loadLocked()
 The immutable state. More...
 

Detailed Description

Abstract base class for PickmapSettings implementations.

Author
Andreas Kirschbaum

Definition at line 29 of file AbstractPickmapSettings.java.

Member Function Documentation

◆ addPickmapSettingsListener()

void net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.addPickmapSettingsListener ( @NotNull final PickmapSettingsListener  listener)

Adds a PickmapSettingsListener to be notified about changes.

Parameters
listenerthe listener to add

Implements net.sf.gridarta.model.pickmapsettings.PickmapSettings.

Definition at line 43 of file AbstractPickmapSettings.java.

References net.sf.gridarta.utils.EventListenerList2< T extends EventListener >.add().

+ Here is the call graph for this function:

◆ fireLockedChanged()

void net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.fireLockedChanged ( )
private

Informs all registered listeners that the immutable state has changed.

Definition at line 71 of file AbstractPickmapSettings.java.

References net.sf.gridarta.utils.EventListenerList2< T extends EventListener >.getListeners(), net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.loadLocked(), and net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.saveLocked().

Referenced by net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.setLocked().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isLocked()

boolean net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.isLocked ( )

Returns whether pickmaps are immutable.

Returns
whether pickmaps are immutable

Implements net.sf.gridarta.model.pickmapsettings.PickmapSettings.

Definition at line 53 of file AbstractPickmapSettings.java.

References net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.locked.

◆ loadLocked()

abstract boolean net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.loadLocked ( )
abstractprotected

Loads the default value for locked.

Returns
the default value

Referenced by net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.fireLockedChanged().

+ Here is the caller graph for this function:

◆ removePickmapSettingsListener()

void net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.removePickmapSettingsListener ( @NotNull final PickmapSettingsListener  listener)

Removes a PickmapSettingsListener to be notified about changes.

Parameters
listenerthe listener to remove

Implements net.sf.gridarta.model.pickmapsettings.PickmapSettings.

Definition at line 48 of file AbstractPickmapSettings.java.

References net.sf.gridarta.utils.EventListenerList2< T extends EventListener >.remove().

+ Here is the call graph for this function:

◆ saveLocked()

abstract void net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.saveLocked ( boolean  locked)
abstractprotected

Saves the locked value.

Parameters
lockedthe locked value

Referenced by net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.fireLockedChanged(), and net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.setLocked().

+ Here is the caller graph for this function:

◆ setLocked()

void net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.setLocked ( final boolean  locked)

Sets whether pickmaps are immutable.

Parameters
lockedwhether pickmaps are immutable

Implements net.sf.gridarta.model.pickmapsettings.PickmapSettings.

Definition at line 58 of file AbstractPickmapSettings.java.

References net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.fireLockedChanged(), net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.locked, and net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.saveLocked().

+ Here is the call graph for this function:

Member Data Documentation

◆ listenerList

final EventListenerList2<PickmapSettingsListener> net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.listenerList = new EventListenerList2<>(PickmapSettingsListener.class)
private

The MapViewSettingsListeners to inform of changes.

Definition at line 35 of file AbstractPickmapSettings.java.

◆ locked

boolean net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.locked = loadLocked()
private

The immutable state.

Definition at line 40 of file AbstractPickmapSettings.java.

Referenced by net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.isLocked(), and net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.setLocked().

The documentation for this class was generated from the following file: