Package repast.simphony.gis.legend

Class LegendLayerEntry

java.lang.Object

javax.swing.tree.DefaultMutableTreeNode

repast.simphony.gis.legend.LegendEntry

repast.simphony.gis.legend.LegendLayerEntry

All Implemented Interfaces:

Serializable, Cloneable, MutableTreeNode, TreeNode

public class LegendLayerEntry
extends LegendEntry

Deprecated.

2D piccolo based code is being removed

Used to keep the information about legend tree root and layer node such as name, expanded icon, collapsed icon, and isSelected when mean isLayerVisible or does user select the checkbox for this layer node

Author:

howe

See Also:

• Serialized Form

Field Summary

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

Constructors

Constructor	Description
LegendLayerEntry(String name, boolean isLayerSelected, org.geotools.map.Layer layer)	Deprecated. Create a new LegendLayer node for a layer.

Method Summary

Modifier and Type	Method	Description
Color	getBackground(boolean selected)	Deprecated. Get the background color for this node based on whether the node is selected or not.
Icon	getIcon(boolean expanded)	Deprecated. Get the icon for this entry.
org.geotools.map.Layer	getLayer()	Deprecated.
boolean	isDataVisible()	Deprecated. Is this entry currently selected?
void	setDataVisible(boolean dataVisible)	Deprecated. Set the selected status of this entry.
void	setDataVisible(boolean dataVisible, boolean propogateChanges)	Deprecated. Set the selected status of this entry and whether or not the selected status should be propogated to children.

Methods inherited from class repast.simphony.gis.legend.LegendEntry

getName, setName, toString

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

LegendLayerEntry

public LegendLayerEntry(String name,
 boolean isLayerSelected,
 org.geotools.map.Layer layer)

Deprecated.

Create a new LegendLayer node for a layer.

Parameters:

name - The name of this layer

isLayerSelected - Is this layer currently selected

layer - The layer upon which the node is based

Method Details

setDataVisible

public void setDataVisible(boolean dataVisible)

Deprecated.

Description copied from class: LegendEntry

Set the selected status of this entry.

Overrides:

setDataVisible in class LegendEntry

setDataVisible

public void setDataVisible(boolean dataVisible,
 boolean propogateChanges)

Deprecated.

Set the selected status of this entry and whether or not the selected status should be propogated to children. In this case, propogation does nothing as this has no children.

Overrides:

setDataVisible in class LegendEntry

Parameters:

dataVisible -

propogateChanges - whether not the changes should be propogated to children

isDataVisible

public boolean isDataVisible()

Deprecated.

Description copied from class: LegendEntry

Is this entry currently selected?

Overrides:

isDataVisible in class LegendEntry

Returns:

Whether the entry is selected or not.

getBackground

public Color getBackground(boolean selected)

Deprecated.

Description copied from class: LegendEntry

Get the background color for this node based on whether the node is selected or not.

Overrides:

getBackground in class LegendEntry

Parameters:

selected - Is this entry currently selected?

Returns:

The background color for this entry.

getLayer

public org.geotools.map.Layer getLayer()

Deprecated.

getIcon

public Icon getIcon(boolean expanded)

Deprecated.

Description copied from class: LegendEntry

Get the icon for this entry. The generic legend entry has no icon associated with it.

Overrides:

getIcon in class LegendEntry

Parameters:

expanded - Is this entry selected?

Returns:

The icon, null in the general case.