svn-gvsig-desktop / trunk / org.gvsig.desktop / org.gvsig.desktop.compat.cdc / org.gvsig.fmap.mapcontext / org.gvsig.fmap.mapcontext.api / src / main / java / org / gvsig / fmap / mapcontext / rendering / legend / ILegend.java @ 40559
History | View | Annotate | Download (2.38 KB)
| 1 |
/**
|
|---|---|
| 2 |
* gvSIG. Desktop Geographic Information System.
|
| 3 |
*
|
| 4 |
* Copyright (C) 2007-2013 gvSIG Association.
|
| 5 |
*
|
| 6 |
* This program is free software; you can redistribute it and/or
|
| 7 |
* modify it under the terms of the GNU General Public License
|
| 8 |
* as published by the Free Software Foundation; either version 3
|
| 9 |
* of the License, or (at your option) any later version.
|
| 10 |
*
|
| 11 |
* This program is distributed in the hope that it will be useful,
|
| 12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
| 14 |
* GNU General Public License for more details.
|
| 15 |
*
|
| 16 |
* You should have received a copy of the GNU General Public License
|
| 17 |
* along with this program; if not, write to the Free Software
|
| 18 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
| 19 |
* MA 02110-1301, USA.
|
| 20 |
*
|
| 21 |
* For any additional information, do not hesitate to contact us
|
| 22 |
* at info AT gvsig.com, or visit our website www.gvsig.com.
|
| 23 |
*/
|
| 24 |
package org.gvsig.fmap.mapcontext.rendering.legend; |
| 25 |
|
| 26 |
import org.gvsig.fmap.mapcontext.rendering.legend.events.LegendContentsChangedListener; |
| 27 |
import org.gvsig.fmap.mapcontext.rendering.legend.events.SymbolLegendEvent; |
| 28 |
import org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol; |
| 29 |
import org.gvsig.tools.lang.Cloneable; |
| 30 |
import org.gvsig.tools.persistence.Persistent; |
| 31 |
|
| 32 |
/**
|
| 33 |
* Information about the legend to be represented in the interface.
|
| 34 |
*
|
| 35 |
*/
|
| 36 |
public interface ILegend extends Persistent, Cloneable { |
| 37 |
/**
|
| 38 |
* Obtains the default symbol of the legend.
|
| 39 |
*
|
| 40 |
* @return default symbol.
|
| 41 |
*/
|
| 42 |
ISymbol getDefaultSymbol(); |
| 43 |
|
| 44 |
/**
|
| 45 |
* Clones the legend.
|
| 46 |
*
|
| 47 |
* @return Cloned legend.
|
| 48 |
*
|
| 49 |
* @throws XMLException
|
| 50 |
*/
|
| 51 |
ILegend cloneLegend(); |
| 52 |
/**
|
| 53 |
* Adds a new listener to the legend.
|
| 54 |
*
|
| 55 |
* @param listener to be added
|
| 56 |
*/
|
| 57 |
void addLegendListener(LegendContentsChangedListener listener);
|
| 58 |
/**
|
| 59 |
* Removes a listener from the legend.
|
| 60 |
*
|
| 61 |
* @param listener to be removed
|
| 62 |
*/
|
| 63 |
public void removeLegendListener(LegendContentsChangedListener listener); |
| 64 |
/**
|
| 65 |
* Executed when the default symbol of a legend is changed.
|
| 66 |
*
|
| 67 |
* @param event
|
| 68 |
*/
|
| 69 |
public void fireDefaultSymbolChangedEvent(SymbolLegendEvent event); |
| 70 |
/**
|
| 71 |
* Obtains the listeners of a legend.
|
| 72 |
*
|
| 73 |
* @return LegendListener[] array composed by the listeners of a legend.
|
| 74 |
*/
|
| 75 |
public LegendContentsChangedListener[] getListeners(); |
| 76 |
} |
| 77 |
|