Gridarta Editor
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 Collection< PickmapSettingsListenerlistenerList = new CopyOnWriteArrayList<>()
 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 30 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 44 of file AbstractPickmapSettings.java.

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

◆ fireLockedChanged()

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

Informs all registered listeners that the immutable state has changed.

Definition at line 72 of file AbstractPickmapSettings.java.

References net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.listenerList, and net.sf.gridarta.model.pickmapsettings.AbstractPickmapSettings.locked.

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

+ 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 54 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

Reimplemented in net.sf.gridarta.model.pickmapsettings.DefaultPickmapSettings.

◆ 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 49 of file AbstractPickmapSettings.java.

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

◆ saveLocked()

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

Saves the locked value.

Parameters
lockedthe locked value

Reimplemented in net.sf.gridarta.model.pickmapsettings.DefaultPickmapSettings.

Referenced by 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)

Member Data Documentation

◆ listenerList

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

◆ locked


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