public interface ILegendPanel
Modifier and Type | Method and Description |
---|---|
String |
getDescription()
Returns a brief human-readable description about what kind of legend builds this panel
|
ImageIcon |
getIcon()
Returns the icon which should graphically describe what this panel's legend does.
|
ILegend |
getLegend()
Returns an instance of Legend
|
Class |
getLegendClass()
Returns the class of the legend produced by this ILegendPanel.
|
JPanel |
getPanel()
If this is a complete panel (it is a child node in the legend tree) to set up a legend
this method will return a JPanel containing the necessary components.
|
Class |
getParentClass()
If this panel should appear as a subnode of the legends tree, in other words it is not
a first-level node, then this method would return its parent's class.
|
String |
getTitle()
Returns the title (a human-readable one) of this panel.
|
boolean |
isSuitableFor(FLayer layer)
Returns true if this legend is applicable to this layer, false otherwise.
|
void |
setData(FLayer lyr,
ILegend legend)
Initializes the data required for this legend panel.
|
void setData(FLayer lyr, ILegend legend)
lyr,
- target layerlegend,
- the legend currently applied to lyrILegend getLegend()
String getDescription()
ImageIcon getIcon()
Class getParentClass()
String getTitle()
JPanel getPanel()
If this is a complete panel (it is a child node in the legend tree) to set up a legend
this method will return a JPanel containing the necessary components. Otherwise, if
it is just a classification node (it has children) in the legend tree it will return
just null.
If null is returned, the ILegendPanel that will be shown and selected each time it is selected is the very first child of this parent node.
Class getLegendClass()
boolean isSuitableFor(FLayer layer)