org.gvsig.educa.portableview.swing.impl.viewer

Class DefaultPortableViewToc

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.gvsig.educa.portableview.swing.impl.viewer.DefaultPortableViewToc

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.TreeSelectionListener, PortableViewSwingComponent, PortableViewToc, LayerListener, TOC, Service

public class DefaultPortableViewToc
extends javax.swing.JPanel
implements PortableViewToc, LayerListener, javax.swing.event.TreeSelectionListener

Default implementation of PortableViewToc

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
DefaultPortableViewToc()

Method Summary

Modifier and Type	Method and Description
void	activationChanged(LayerEvent e) Called when the activation of a layer has changed.
void	addActiveLayerChangeListener(ActiveLayerChangeEventListener alcel) Adds a active layer change listener.
void	addLayerActionListener(LayerActionEventListener lel) Adds a layer action listener.
void	addLegendActionListener(LegendActionEventListener lel) Adds a legend action listener.
void	attachTo(PortableViewViewer viewer)
void	clearSelection() Clears current layer selection
void	drawValueChanged(LayerEvent e) Called when a draw value of a layer has changed.
void	editionChanged(LayerEvent e) Called when the edition of a layer has changed.
FLayer	getActiveLayer()
javax.swing.JComponent	getComponent()
TOCFactory	getFactory()
Manager	getManager() Returns a reference to the Manager which manages this server.
MapContext	getMapContext()
DynObject	getParameters() Gets the parameters that were used to instantiate this TOC.
FLayer[]	getSelectedLayers()
javax.swing.JComponent	getSwingComponent()
PortableViewViewer	getViewer()
void	hideAll() Hides as much as possible the graphic representation of the TOC (for example, collapses all the nodes to hide all layer details except the list of layers itself)
void	hideAllLegends() Collapses all graphic representation of layer legends
void	hideLegend(FLayer lyr) Makes layer legend details not visible
void	invokeAction(FLayer lyr, java.lang.String action) Invokes a certain action on a certain layer
void	nameChanged(LayerEvent e) Called when the name of a layer has changed.
protected void	processTreeMouseEvent(java.awt.event.MouseEvent e)
void	removeActiveLayerChangeListener(ActiveLayerChangeEventListener alcel) Removes a active layer change listener
void	removeLayerActionListener(LayerActionEventListener lel) Removes a layer action listener
void	removeLegendActionListener(LegendActionEventListener lel) Removes a legend action listener
void	selectLayer(FLayer lyr) Add a layer to the set of selected layers
void	setActiveLayer(FLayer lyr) Sets a layer as active (exclusively: the number of active layers must be 0 or 1)
void	setImageProvider(PortableViewTocImageProvider imageProvider) Sets the image provider for TOC tree elements
void	show(FLayer lyr, boolean detailed) Makes the name and representation of a certain layer visible in the TOC.
void	showAll() Expands fully the graphic representation of the TOC (for example, expands all the nodes to show all layer details)
void	showAllLegends() Expands all graphic representation of layer legends
void	showLegend(FLayer lyr) Makes layer legend details visible
void	unselectLayer(FLayer lyr) Removes a layer from the set of selected layers
void	valueChanged(javax.swing.event.TreeSelectionEvent e)
void	visibilityChanged(LayerEvent e) Called when the visibility of a layer has changed.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPortableViewToc

public DefaultPortableViewToc()

Method Detail

setImageProvider

public void setImageProvider(PortableViewTocImageProvider imageProvider)

Description copied from interface: PortableViewToc

Sets the image provider for TOC tree elements

Specified by:

setImageProvider in interface PortableViewToc

getSwingComponent

public javax.swing.JComponent getSwingComponent()

Specified by:

getSwingComponent in interface PortableViewSwingComponent

Returns:

getSelectedLayers

public FLayer[] getSelectedLayers()

Specified by:

getSelectedLayers in interface TOC

Returns:

array of selected layers

attachTo

public void attachTo(PortableViewViewer viewer)

Specified by:

attachTo in interface PortableViewToc

getViewer

public PortableViewViewer getViewer()

Specified by:

getViewer in interface PortableViewToc

Returns:

getParameters

public DynObject getParameters()

Description copied from interface: TOC

Gets the parameters that were used to instantiate this TOC. Normally, the @see MapContext

Specified by:

getParameters in interface TOC

Returns:

a dynobject containing the parameters

getFactory

public TOCFactory getFactory()

Specified by:

getFactory in interface TOC

Returns:

the TOCFactory that created this TOC.

getComponent

public javax.swing.JComponent getComponent()

Specified by:

getComponent in interface TOC

Returns:

the Swing component that represents this TOC (for example a JTree or a JPanel with a JTree in it)

getMapContext

public MapContext getMapContext()

Specified by:

getMapContext in interface TOC

Returns:

the MapContext on which this TOC is necessarily based

showAll

public void showAll()

Description copied from interface: TOC

Expands fully the graphic representation of the TOC (for example, expands all the nodes to show all layer details)

Specified by:

showAll in interface TOC

hideAll

public void hideAll()

Description copied from interface: TOC

Hides as much as possible the graphic representation of the TOC (for example, collapses all the nodes to hide all layer details except the list of layers itself)

Specified by:

hideAll in interface TOC

showAllLegends

public void showAllLegends()

Description copied from interface: TOC

Expands all graphic representation of layer legends

Specified by:

showAllLegends in interface TOC

hideAllLegends

public void hideAllLegends()

Description copied from interface: TOC

Collapses all graphic representation of layer legends

Specified by:

hideAllLegends in interface TOC

show

public void show(FLayer lyr,
                 boolean detailed)

Description copied from interface: TOC

Makes the name and representation of a certain layer visible in the TOC. For example, the TOC might be a JTree inside a scroll pane. This method would scroll down the scroll pane to let the user see the layer is listed

Specified by:

show in interface TOC

Parameters:

lyr - the layer whose name and details must be made visible

detailed - whether the layer details must be shown or not

showLegend

public void showLegend(FLayer lyr)

Description copied from interface: TOC

Makes layer legend details visible

Specified by:

showLegend in interface TOC

Parameters:

lyr - layer whose legend details must be shown

hideLegend

public void hideLegend(FLayer lyr)

Description copied from interface: TOC

Makes layer legend details not visible

Specified by:

hideLegend in interface TOC

Parameters:

lyr - layer whose legend details must be hidden

selectLayer

public void selectLayer(FLayer lyr)

Description copied from interface: TOC

Add a layer to the set of selected layers

Specified by:

selectLayer in interface TOC

Parameters:

lyr - layer which must be selected (not exclusively)

unselectLayer

public void unselectLayer(FLayer lyr)

Description copied from interface: TOC

Removes a layer from the set of selected layers

Specified by:

unselectLayer in interface TOC

Parameters:

lyr - layer which must be unselected

clearSelection

public void clearSelection()

Description copied from interface: TOC

Clears current layer selection

Specified by:

clearSelection in interface TOC

setActiveLayer

public void setActiveLayer(FLayer lyr)

Description copied from interface: TOC

Sets a layer as active (exclusively: the number of active layers must be 0 or 1)

Specified by:

setActiveLayer in interface TOC

Parameters:

lyr - layer to be set as active or null to have 0 layers active

getActiveLayer

public FLayer getActiveLayer()

Specified by:

getActiveLayer in interface TOC

Returns:

the currently active layer or null if no layer is active

invokeAction

public void invokeAction(FLayer lyr,
                         java.lang.String action)

Description copied from interface: TOC

Invokes a certain action on a certain layer

Specified by:

invokeAction in interface TOC

Parameters:

lyr - the layer on which the action will be performed

action - the action to be performed

addLegendActionListener

public void addLegendActionListener(LegendActionEventListener lel)

Description copied from interface: TOC

Adds a legend action listener. These listeners will be notified when the user shows interest in a legend symbol (typically double click)

Specified by:

addLegendActionListener in interface TOC

Parameters:

lel - new legend action listener

removeLegendActionListener

public void removeLegendActionListener(LegendActionEventListener lel)

Description copied from interface: TOC

Removes a legend action listener

Specified by:

removeLegendActionListener in interface TOC

Parameters:

lel - legend action listener to be removed

addLayerActionListener

public void addLayerActionListener(LayerActionEventListener lel)

Description copied from interface: TOC

Adds a layer action listener. These listeners will be notified when the user shows interest in a layer (typically double click)

Specified by:

addLayerActionListener in interface TOC

Parameters:

lel - new layer action listener

removeLayerActionListener

public void removeLayerActionListener(LayerActionEventListener lel)

Description copied from interface: TOC

Removes a layer action listener

Specified by:

removeLayerActionListener in interface TOC

Parameters:

lel - layer action listener to be removed

addActiveLayerChangeListener

public void addActiveLayerChangeListener(ActiveLayerChangeEventListener alcel)

Description copied from interface: TOC

Adds a active layer change listener. These listeners will be notified when a new layer is set as active

Specified by:

addActiveLayerChangeListener in interface TOC

Parameters:

alcel - new active layer change listener

removeActiveLayerChangeListener

public void removeActiveLayerChangeListener(ActiveLayerChangeEventListener alcel)

Description copied from interface: TOC

Removes a active layer change listener

Specified by:

removeActiveLayerChangeListener in interface TOC

Parameters:

alcel - active layer change listener to be removed

getManager

public Manager getManager()

Description copied from interface: Service

Returns a reference to the Manager which manages this server.

Specified by:

getManager in interface Service

Returns:

the server's Manager

visibilityChanged

public void visibilityChanged(LayerEvent e)

Description copied from interface: LayerListener

Called when the visibility of a layer has changed.

Specified by:

visibilityChanged in interface LayerListener

Parameters:

e - a visibility changed layer event object

activationChanged

public void activationChanged(LayerEvent e)

Description copied from interface: LayerListener

Called when the activation of a layer has changed.

Specified by:

activationChanged in interface LayerListener

Parameters:

e - an activation changed layer event object

nameChanged

public void nameChanged(LayerEvent e)

Description copied from interface: LayerListener

Called when the name of a layer has changed.

Specified by:

nameChanged in interface LayerListener

Parameters:

e - a name changed layer event object

editionChanged

public void editionChanged(LayerEvent e)

Description copied from interface: LayerListener

Called when the edition of a layer has changed.

Specified by:

editionChanged in interface LayerListener

Parameters:

e - an edition changed layer event object

drawValueChanged

public void drawValueChanged(LayerEvent e)

Description copied from interface: LayerListener

Called when a draw value of a layer has changed.

Specified by:

drawValueChanged in interface LayerListener

Parameters:

e - an edition changed layer event object

processTreeMouseEvent

protected void processTreeMouseEvent(java.awt.event.MouseEvent e)

valueChanged

public void valueChanged(javax.swing.event.TreeSelectionEvent e)

Specified by:

valueChanged in interface javax.swing.event.TreeSelectionListener