LayerListDialog.LayerListModel (JOSM)

java.lang.Object
- javax.swing.table.AbstractTableModel
- - org.openstreetmap.josm.gui.dialogs.LayerListDialog.LayerListModel

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.swing.table.TableModel, LayerManager.LayerChangeListener, MainLayerManager.ActiveLayerChangeListener

Enclosing class:

LayerListDialog
```
public static final class LayerListDialog.LayerListModel
extends javax.swing.table.AbstractTableModel
implements LayerManager.LayerChangeListener, MainLayerManager.ActiveLayerChangeListener, java.beans.PropertyChangeListener
```
The layer list model. The model manages a list of layers and provides methods for moving layers up and down, for toggling their visibility, and for activating a layer. The model is a TableModel and it provides a ListSelectionModel. It expects to be configured with a DefaultListSelectionModel. The selection model is used to update the selection state of views depending on messages sent to the model. The model manages a list of LayerListDialog.LayerListModelListener which are mainly notified if the model requires views to make a specific list entry visible. It also listens to PropertyChangeEvents of every Layer it manages, in particular to the properties Layer.VISIBLE_PROP and Layer.NAME_PROP.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private LayerListDialog.LayerList`	`layerList`
`private MainLayerManager`	`layerManager`
`private java.util.concurrent.CopyOnWriteArrayList<LayerListDialog.LayerListModelListener>`	`listeners`
`private javax.swing.DefaultListSelectionModel`	`selectionModel` manages list selection state

Fields inherited from class javax.swing.table.AbstractTableModel
listenerList

Constructor Summary

Constructors
Constructor and Description

LayerListModel(MainLayerManager layerManager, javax.swing.DefaultListSelectionModel selectionModel)
constructor

Constructors
Constructor and Description
`LayerListModel(MainLayerManager layerManager, javax.swing.DefaultListSelectionModel selectionModel)` constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activeOrEditLayerChanged(MainLayerManager.ActiveLayerChangeEvent e)` Called whenever the active or edit layer changed.
`void`	`addLayerListModelListener(LayerListDialog.LayerListModelListener listener)` Adds a listener to this model
`boolean`	`canMoveDown()` Replies true if the currently selected layers can move down by one position
`boolean`	`canMoveUp()` Replies true if the currently selected layers can move up by one position
`protected void`	`ensureActiveSelected()` Ensures that at least one layer is selected in the layer dialog
`protected void`	`ensureSelectedIsVisible()` Make sure the first of the selected layers is visible in the views of this model.
`protected void`	`fireMakeVisible(int index, Layer layer)` Fires a make visible event to listeners
`protected void`	`fireRefresh()` Fires a refresh event to listeners of this model
`protected Layer`	`getActiveLayer()` Replies the active layer.
`int`	`getColumnCount()`
`Layer`	`getFirstLayer()` Replies the first layer.
`Layer`	`getLayer(int index)` Replies the layer at position `index`
`MainLayerManager`	`getLayerManager()` The layer manager this model is for.
`java.util.List<Layer>`	`getLayers()` Replies the list of layers currently managed by `MapView`.
`protected NativeScaleLayer`	`getNativeScaleLayer()` Deprecated. Deprecated since it is unused in JOSM and does not really belong here. Can be removed soon (August 2016). You can directly query MapView.
`java.util.List<Layer>`	`getPossibleMergeTargets(Layer source)` Replies a list of layers which are possible merge targets for `source`
`int`	`getRowCount()`
`java.util.List<Layer>`	`getSelectedLayers()` Replies the list of currently selected layers.
`java.util.List<java.lang.Integer>`	`getSelectedRows()` Replies a the list of indices of the selected rows.
`java.lang.Object`	`getValueAt(int row, int col)`
`boolean`	`isCellEditable(int row, int col)`
`void`	`layerAdded(LayerManager.LayerAddEvent e)` Notifies this listener that a layer has been added.
`void`	`layerOrderChanged(LayerManager.LayerOrderChangeEvent e)` Notifies this listener that the order of layers was changed.
`void`	`layerRemoving(LayerManager.LayerRemoveEvent e)` Notifies this listener that a layer is about to be removed.
`void`	`moveDown()` Move down the currently selected layers by one position
`void`	`moveUp()` Move up the currently selected layers by one position
`private void`	`onAddLayer(Layer layer)` Invoked when a layer managed by `MapView` is added
`private void`	`onRemoveLayer(Layer layer)` Invoked if a layer managed by `MapView` is removed
`void`	`populate()` Populates the model with the current layers managed by `MapView`.
`void`	`propertyChange(java.beans.PropertyChangeEvent evt)`
`void`	`removeLayerListModelListener(LayerListDialog.LayerListModelListener listener)` removes a listener from this model
`(package private) void`	`setLayerList(LayerListDialog.LayerList layerList)`
`void`	`setSelectedLayer(Layer layer)` Marks `layer` as selected layer.
`void`	`setValueAt(java.lang.Object value, int row, int col)`

Methods inherited from class javax.swing.table.AbstractTableModel
addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getColumnClass, getColumnName, getListeners, getTableModelListeners, removeTableModelListener

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - selectionModel
```
private final javax.swing.DefaultListSelectionModel selectionModel
```
    manages list selection state
  - listeners
```
private final java.util.concurrent.CopyOnWriteArrayList<LayerListDialog.LayerListModelListener> listeners
```
  - layerList
```
private LayerListDialog.LayerList layerList
```
  - layerManager
```
private final MainLayerManager layerManager
```
- Constructor Detail
  - LayerListModel
```
LayerListModel(MainLayerManager layerManager,
               javax.swing.DefaultListSelectionModel selectionModel)
```
    constructor
    
    Parameters:
    
    layerManager - The layer manager to use for the list.
    
    selectionModel - the list selection model
- Method Detail
  - setLayerList
```
void setLayerList(LayerListDialog.LayerList layerList)
```
  - getLayerManager
```
public MainLayerManager getLayerManager()
```
    The layer manager this model is for.
    
    Returns:
    
    The layer manager.
  - addLayerListModelListener
```
public void addLayerListModelListener(LayerListDialog.LayerListModelListener listener)
```
    Adds a listener to this model
    
    Parameters:
    
    listener - the listener
  - removeLayerListModelListener
```
public void removeLayerListModelListener(LayerListDialog.LayerListModelListener listener)
```
    removes a listener from this model
    
    Parameters:
    
    listener - the listener
  - fireMakeVisible
```
protected void fireMakeVisible(int index,
                               Layer layer)
```
    Fires a make visible event to listeners
    
    Parameters:
    
    index - the index of the row to make visible
    
    layer - the layer at this index
    
    See Also:
    
    LayerListDialog.LayerListModelListener.makeVisible(int, Layer)
  - fireRefresh
```
protected void fireRefresh()
```
    Fires a refresh event to listeners of this model
    
    See Also:
    
    LayerListDialog.LayerListModelListener.refresh()
  - populate
```
public void populate()
```
    Populates the model with the current layers managed by MapView.
  - setSelectedLayer
```
public void setSelectedLayer(Layer layer)
```
    Marks layer as selected layer. Ignored, if layer is null.
    
    Parameters:
    
    layer - the layer.
  - getSelectedLayers
```
public java.util.List<Layer> getSelectedLayers()
```
    Replies the list of currently selected layers. Never null, but may be empty.
    
    Returns:
    
    the list of currently selected layers. Never null, but may be empty.
  - getSelectedRows
```
public java.util.List<java.lang.Integer> getSelectedRows()
```
    Replies a the list of indices of the selected rows. Never null, but may be empty.
    
    Returns:
    
    the list of indices of the selected rows. Never null, but may be empty.
  - onRemoveLayer
```
private void onRemoveLayer(Layer layer)
```
    Invoked if a layer managed by MapView is removed
    
    Parameters:
    
    layer - the layer which is removed
  - onAddLayer
```
private void onAddLayer(Layer layer)
```
    Invoked when a layer managed by MapView is added
    
    Parameters:
    
    layer - the layer
  - getFirstLayer
```
public Layer getFirstLayer()
```
    Replies the first layer. Null if no layers are present
    
    Returns:
    
    the first layer. Null if no layers are present
  - getLayer
```
public Layer getLayer(int index)
```
    Replies the layer at position index
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the layer at position index. Null, if index is out of range.
  - canMoveUp
```
public boolean canMoveUp()
```
    Replies true if the currently selected layers can move up by one position
    
    Returns:
    
    true if the currently selected layers can move up by one position
  - moveUp
```
public void moveUp()
```
    Move up the currently selected layers by one position
  - canMoveDown
```
public boolean canMoveDown()
```
    Replies true if the currently selected layers can move down by one position
    
    Returns:
    
    true if the currently selected layers can move down by one position
  - moveDown
```
public void moveDown()
```
    Move down the currently selected layers by one position
  - ensureSelectedIsVisible
```
protected void ensureSelectedIsVisible()
```
    Make sure the first of the selected layers is visible in the views of this model.
  - getPossibleMergeTargets
```
public java.util.List<Layer> getPossibleMergeTargets(Layer source)
```
    Replies a list of layers which are possible merge targets for source
    
    Parameters:
    
    source - the source layer
    
    Returns:
    
    a list of layers which are possible merge targets for source. Never null, but can be empty.
  - getLayers
```
public java.util.List<Layer> getLayers()
```
    Replies the list of layers currently managed by MapView. Never null, but can be empty.
    
    Returns:
    
    the list of layers currently managed by MapView. Never null, but can be empty.
  - ensureActiveSelected
```
protected void ensureActiveSelected()
```
    Ensures that at least one layer is selected in the layer dialog
  - getActiveLayer
```
protected Layer getActiveLayer()
```
    Replies the active layer. null, if no active layer is available
    
    Returns:
    
    the active layer. null, if no active layer is available
  - getNativeScaleLayer
```
@Deprecated
protected NativeScaleLayer getNativeScaleLayer()
```
    Deprecated. Deprecated since it is unused in JOSM and does not really belong here. Can be removed soon (August 2016). You can directly query MapView.
    
    Replies the scale layer. null, if no active layer is available.
    
    Returns:
    
    the scale layer. null, if no active layer is available
  - getRowCount
```
public int getRowCount()
```
    Specified by:
    
    getRowCount in interface javax.swing.table.TableModel
  - getColumnCount
```
public int getColumnCount()
```
    Specified by:
    
    getColumnCount in interface javax.swing.table.TableModel
  - getValueAt
```
public java.lang.Object getValueAt(int row,
                                   int col)
```
    Specified by:
    
    getValueAt in interface javax.swing.table.TableModel
  - isCellEditable
```
public boolean isCellEditable(int row,
                              int col)
```
    Specified by:
    
    isCellEditable in interface javax.swing.table.TableModel
    
    Overrides:
    
    isCellEditable in class javax.swing.table.AbstractTableModel
  - setValueAt
```
public void setValueAt(java.lang.Object value,
                       int row,
                       int col)
```
    Specified by:
    
    setValueAt in interface javax.swing.table.TableModel
    
    Overrides:
    
    setValueAt in class javax.swing.table.AbstractTableModel
  - activeOrEditLayerChanged
```
public void activeOrEditLayerChanged(MainLayerManager.ActiveLayerChangeEvent e)
```
    Description copied from interface: MainLayerManager.ActiveLayerChangeListener
    
    Called whenever the active or edit layer changed.
    You can be sure that this layer is still contained in this set.
    Listeners are called in the EDT thread and you can manipulate the layer manager in the current thread.
    
    Specified by:
    
    activeOrEditLayerChanged in interface MainLayerManager.ActiveLayerChangeListener
    
    Parameters:
    
    e - The change event.
  - layerAdded
```
public void layerAdded(LayerManager.LayerAddEvent e)
```
    Description copied from interface: LayerManager.LayerChangeListener
    
    Notifies this listener that a layer has been added.
    Listeners are called in the EDT thread and you can manipulate the layer manager in the current thread.
    
    Specified by:
    
    layerAdded in interface LayerManager.LayerChangeListener
    
    Parameters:
    
    e - The new added layer event
  - layerRemoving
```
public void layerRemoving(LayerManager.LayerRemoveEvent e)
```
    Description copied from interface: LayerManager.LayerChangeListener
    
    Notifies this listener that a layer is about to be removed.
    Listeners are called in the EDT thread and you can manipulate the layer manager in the current thread.
    
    Specified by:
    
    layerRemoving in interface LayerManager.LayerChangeListener
    
    Parameters:
    
    e - The layer to be removed (as event)
  - layerOrderChanged
```
public void layerOrderChanged(LayerManager.LayerOrderChangeEvent e)
```
    Description copied from interface: LayerManager.LayerChangeListener
    
    Notifies this listener that the order of layers was changed.
    Listeners are called in the EDT thread and you can manipulate the layer manager in the current thread.
    
    Specified by:
    
    layerOrderChanged in interface LayerManager.LayerChangeListener
    
    Parameters:
    
    e - The order change event.
  - propertyChange
```
public void propertyChange(java.beans.PropertyChangeEvent evt)
```
    Specified by:
    
    propertyChange in interface java.beans.PropertyChangeListener

Class LayerListDialog.LayerListModel

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

Constructor Summary

Method Summary

Methods inherited from class javax.swing.table.AbstractTableModel

Methods inherited from class java.lang.Object

Field Detail

selectionModel

listeners

layerList

layerManager

Constructor Detail

LayerListModel

Method Detail

setLayerList

getLayerManager

addLayerListModelListener

removeLayerListModelListener

fireMakeVisible

fireRefresh

populate

setSelectedLayer

getSelectedLayers

getSelectedRows

onRemoveLayer

onAddLayer

getFirstLayer

getLayer

canMoveUp

moveUp

canMoveDown

moveDown

ensureSelectedIsVisible

getPossibleMergeTargets

getLayers

ensureActiveSelected

getActiveLayer

getNativeScaleLayer

getRowCount

getColumnCount

getValueAt

isCellEditable

setValueAt

activeOrEditLayerChanged

layerAdded

layerRemoving

layerOrderChanged

propertyChange