org.gvsig.fmap.mapcontext.layers.operations

Interface LayerCollection

All Superinterfaces:

LayersVisitable, org.gvsig.tools.visitor.Visitable

All Known Implementing Classes:

FLayers

public interface LayerCollection
extends LayersVisitable

Interface with methods for a collection of layers.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AFTER Value used to specify the insertion after an element.
static int	BEFORE Value used to specify the insertion before an element.
static int	BEGIN Value used to specify the insertion at the beginning.
static int	END Value used to specify the insertion at the end.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayer(FLayer layer) Adds a new layer to this collection.
void	addLayer(FLayer layer, int where, FLayer adjoiningLayer) Adds a new layer to this collection before or after an element if supplied, and if not at the beginning or end of the collection.
void	addLayerCollectionListener(LayerCollectionListener listener) Adds a listener of events produced on a collection of layers.
void	beginDraw(java.awt.Graphics2D g, ViewPort viewPort)
void	endDraw(java.awt.Graphics2D g, ViewPort viewPort)
FLayer[]	getActives() Returns an array with all active layers in this collection.
FLayer	getLayer(int index) Returns the ith-output directed son (from bottom up) of this collection.
FLayer	getLayer(java.lang.String layerName) Returns a first-level layer of this collection, using its name.
int	getLayersCount() Returns the number of layers that are at the first level inside this one.
FLayer[]	getVisibles() Returns an array with all visible layers in this collection.
void	move(FLayer layer, LayerCollection group) Moves a layer from this collection to the end of another collection.
void	move(FLayer layer, LayerCollection group, int where, FLayer adjoiningLayer) Moves a layer from this collection to another collection before or after an element if supplied, and if not at the beginning or end of the collection.
void	moveTo(int from, int to) Moves a layer of the collection to another position in internal list.
void	removeLayer(FLayer lyr) Removes a layer from this collection.
void	removeLayer(int idLayer) Removes a layer using its identifier.
void	removeLayer(java.lang.String layerName) Removes a layer using its name.
void	removeLayerCollectionListener(LayerCollectionListener listener) Removes a listener of events produced on a collection of layers.
void	setAllActives(boolean active) Changes the status of all layers to active or inactive.
void	setAllVisibles(boolean visible) Changes the status of all layers to visible or invisible.

Methods inherited from interface org.gvsig.fmap.mapcontext.layers.operations.LayersVisitable

accept

Methods inherited from interface org.gvsig.tools.visitor.Visitable

accept

Field Detail

AFTER

static final int AFTER

Value used to specify the insertion after an element.

See Also:

Constant Field Values

BEFORE

static final int BEFORE

Value used to specify the insertion before an element.

See Also:

Constant Field Values

BEGIN

static final int BEGIN

Value used to specify the insertion at the beginning.

See Also:

Constant Field Values

END

static final int END

Value used to specify the insertion at the end.

See Also:

Constant Field Values

Method Detail

addLayer

void addLayer(FLayer layer)
              throws CancelationException,
                     LoadLayerException

Adds a new layer to this collection.

Parameters:

layer - the new layer

Throws:

CancelationException - any exception produced during the cancellation of the driver.

LoadLayerException - any exception produced loading the layer.

See Also:

removeLayer(FLayer), removeLayer(int), removeLayer(String)

addLayer

void addLayer(FLayer layer,
            int where,
            FLayer adjoiningLayer)
              throws LayerNotFoundInCollectionException

Adds a new layer to this collection before or after an element if supplied, and if not at the beginning or end of the collection.

.

Parameters:

layer - a FLayer to move

group - a LayerCollection in which the layer has to be moved

where - the position parameter. The valid values are:
0 = BEGIN (first position)
1 = END (last position)
2 = BEFORE (before target layer)
3 = AFTER (after target layer)

adjoiningLayer - a FLayer a layer adjacent to where to insert the layer.

Throws:

CancelationException - any exception produced during the cancellation of the driver.

LoadLayerException - any exception produced loading the layer.

LayerNotFoundInCollectionException

See Also:

#moveTo(FLayer, LayerCollection, int, FLayer)

addLayerCollectionListener

void addLayerCollectionListener(LayerCollectionListener listener)

Adds a listener of events produced on a collection of layers.

Parameters:

listener - a LayerCollectionListener

See Also:

removeLayerCollectionListener(LayerCollectionListener)

beginDraw

void beginDraw(java.awt.Graphics2D g,
             ViewPort viewPort)

endDraw

void endDraw(java.awt.Graphics2D g,
           ViewPort viewPort)

getActives

FLayer[] getActives()

Returns an array with all active layers in this collection.

Returns:

array with first-level active layer nodes, or null if no there is no layer actived

See Also:

setAllActives(boolean)

getLayer

FLayer getLayer(int index)

Returns the ith-output directed son (from bottom up) of this collection.

Parameters:

index - index of the ith-output layer in this collection.

Returns:

a layer

See Also:

getLayer(String)

getLayer

FLayer getLayer(java.lang.String layerName)

Returns a first-level layer of this collection, using its name.

Parameters:

layerName - name of a layer of this collection

Returns:

a layer

See Also:

getLayer(int)

getLayersCount

int getLayersCount()

Returns the number of layers that are at the first level inside this one.

Doesn't counts the sublayers (of FLayers subnodes).

Returns:

number >= 0 with layers that are at the same first-level

See Also:

getLayer(int), getLayer(String)

getVisibles

FLayer[] getVisibles()

Returns an array with all visible layers in this collection.

Returns:

array with first-level visible layer nodes, or null if no there is no layer visible

See Also:

setAllVisibles(boolean)

move

void move(FLayer layer,
        LayerCollection group)

Moves a layer from this collection to the end of another collection.

Parameters:

layer - a FLayer to move

group - a LayerCollection in which the layer has to be moved

Throws:

LayerNotFoundInCollectionException

move

void move(FLayer layer,
        LayerCollection group,
        int where,
        FLayer adjoiningLayer)
          throws LayerNotFoundInCollectionException

Moves a layer from this collection to another collection before or after an element if supplied, and if not at the beginning or end of the collection.

Parameters:

layer - a FLayer to move

group - a LayerCollection in which the layer has to be moved

where - the position parameter. The valid values are:
0 = BEGIN (first position)
1 = END (last position)
2 = BEFORE (before target layer)
3 = AFTER (after target layer)

adjoiningLayer - a FLayer a layer adjacent to where to insert the layer.

Throws:

LayerNotFoundInCollectionException

See Also:

addLayer(FLayer, int, FLayer)

moveTo

void moveTo(int from,
          int to)
            throws CancelationException

Moves a layer of the collection to another position in internal list. It doesn't consider sub-nodes of layers.

Parameters:

from - origin position

to - destination position

Throws:

CancelationException - any exception produced during the cancellation of the driver.

removeLayer

void removeLayer(FLayer lyr)
                 throws CancelationException

Removes a layer from this collection.

Parameters:

lyr - a layer

Throws:

CancelationException - any exception produced during the cancellation of the driver.

See Also:

removeLayer(int), removeLayer(String), addLayer(FLayer)

removeLayer

void removeLayer(int idLayer)

Removes a layer using its identifier.

Parameters:

idLayer - layer identifier

See Also:

removeLayer(FLayer), removeLayer(String), addLayer(FLayer)

removeLayer

void removeLayer(java.lang.String layerName)

Removes a layer using its name.

Parameters:

layerName - the name of the layer

See Also:

removeLayer(FLayer), removeLayer(int), addLayer(FLayer)

removeLayerCollectionListener

void removeLayerCollectionListener(LayerCollectionListener listener)

Removes a listener of events produced on a collection of layers.

Parameters:

listener - a LayerCollectionListener

See Also:

addLayerCollectionListener(LayerCollectionListener)

setAllActives

void setAllActives(boolean active)

Changes the status of all layers to active or inactive.

Parameters:

active - a boolean value

See Also:

getActives()

setAllVisibles

void setAllVisibles(boolean visible)

Changes the status of all layers to visible or invisible.

Parameters:

visible - a boolean value

See Also:

getVisibles()