Module org.arakhne.afc.gis.giscore
Package org.arakhne.afc.gis.maplayer
Class MapLayerHierarchyEvent
- java.lang.Object
-
- java.util.EventObject
-
- org.arakhne.afc.gis.maplayer.ConsumableEvent
-
- org.arakhne.afc.gis.maplayer.MapLayerHierarchyEvent
-
- All Implemented Interfaces:
Serializable
public class MapLayerHierarchyEvent extends ConsumableEvent
This interface representes an event on the hierarchy change inside a set of layers.- Since:
- 14.0
- Version:
- 17.0 2020-01-04 14:41:53
- Author:
- Stéphane GALLAND
- See Also:
- Serialized Form
- Maven Group Id:
- org.arakhne.afc.gis
- Maven Artifact Id:
- giscore
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MapLayerHierarchyEvent.Type
This interface representes the types of hierarchy events.
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor Description MapLayerHierarchyEvent(GISLayerContainer<?> parentLayer, List<? extends MapLayer> childLayers, MapLayerHierarchyEvent.Type type, int index, boolean temporaryChange)
Constructor.MapLayerHierarchyEvent(GISLayerContainer<?> parentLayer, MapLayer childLayer, MapLayerHierarchyEvent.Type type, int index, boolean temporaryChange)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MapLayer
getChild()
Replies the child layer.List<? extends MapLayer>
getChildren()
Replies the child layers.int
getIndex()
Replies the index of the layer in its parent.GISLayerContainer<?>
getParent()
Replies the parent layer.MapLayerHierarchyEvent.Type
getType()
Replies the type of event.boolean
isTemporaryChange()
Replies if the change in the layer was marked as temporary.-
Methods inherited from class org.arakhne.afc.gis.maplayer.ConsumableEvent
consume, isConsumed, isDisappearingWhenConsumed
-
Methods inherited from class java.util.EventObject
getSource, toString
-
-
-
-
Constructor Detail
-
MapLayerHierarchyEvent
public MapLayerHierarchyEvent(GISLayerContainer<?> parentLayer, MapLayer childLayer, MapLayerHierarchyEvent.Type type, int index, boolean temporaryChange)
Constructor.- Parameters:
parentLayer
- the parent layer.childLayer
- the child layer.type
- the type of event.index
- the layer's index.temporaryChange
- indicates if the change is temporary in time. The usage of this information depends on the listener's behaviour.
-
MapLayerHierarchyEvent
public MapLayerHierarchyEvent(GISLayerContainer<?> parentLayer, List<? extends MapLayer> childLayers, MapLayerHierarchyEvent.Type type, int index, boolean temporaryChange)
Constructor.- Parameters:
parentLayer
- the parent layer.childLayers
- the child layers.type
- the type of event.index
- the layer's index.temporaryChange
- indicates if the change is temporary in time. The usage of this information depends on the listener's behaviour.
-
-
Method Detail
-
getIndex
@Pure public int getIndex()
Replies the index of the layer in its parent.- Returns:
- the index of the layer in its parent.
-
getType
@Pure public MapLayerHierarchyEvent.Type getType()
Replies the type of event.- Returns:
- the type of event.
-
getParent
@Pure public GISLayerContainer<?> getParent()
Replies the parent layer.- Returns:
- the parent layer.
-
getChild
@Pure public MapLayer getChild()
Replies the child layer.- Returns:
- the child layer.
-
getChildren
@Pure public List<? extends MapLayer> getChildren()
Replies the child layers.- Returns:
- the child layers.
-
isTemporaryChange
@Pure public boolean isTemporaryChange()
Replies if the change in the layer was marked as temporary. The usage of this information depends on the listener's behaviour.- Returns:
true
if the change is temporary, otherwisefalse
-
-