org.gvsig.fmap.mapcontext.layers.order

Interface LayerOrderManager

All Superinterfaces:

java.lang.Cloneable, org.gvsig.tools.persistence.Persistent

public interface LayerOrderManager
extends org.gvsig.tools.persistence.Persistent, java.lang.Cloneable

This manager will decide the position where layers (FLayer) are added to a layer collection (FLayers)

Author:

gvSIG Team

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone()
java.lang.String	getCode() Gets the code used to register this OrderManager.
java.lang.String	getDescription() Gets the description.
java.lang.String	getName() Gets the name.
int	getPosition(FLayers target, FLayer newLayer) Gets the proposed position for the newLayer in the target layer collection.

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Method Detail

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

getCode

java.lang.String getCode()

Gets the code used to register this OrderManager.

Returns:

The code used to register this orderManager

getDescription

java.lang.String getDescription()

Gets the description. The description should be enough to get an idea of the policy and features of this OrderManager.

Returns:

The description of the OrderManager

getName

java.lang.String getName()

Gets the name. The name should identify the policy followed by this OrderManager to sort the layers.

Returns:

The name of the OrderManager

getPosition

int getPosition(FLayers target,
              FLayer newLayer)

Gets the proposed position for the newLayer in the target layer collection. The OrderManager will study the arrangement of the target layer collection and will decide the right position for the new layer, according to its own criterion.

Parameters:

target - The target collection to which newLayer will be added

newLayer - The layer to be inserted in the layer collection

Returns:

The proposed position for the new layer