pt.lsts.neptus.console

Interface IConsoleLayer

All Superinterfaces:

PropertiesProvider, Renderer2DPainter

All Known Implementing Classes:

ConsoleLayer, MapShortcutsLayer, PlanSimulationLayer

public interface IConsoleLayer
extends Renderer2DPainter, PropertiesProvider

This interface is implemented by layer plugins that show up in the console's Map

Author:

zp

Method Summary

Methods

Modifier and Type	Method and Description
org.dom4j.Element	asElement(java.lang.String rootElement) Save the configurations of this layer as XML
void	clean() This layer has been removed or the MapPanel was closed.
javax.swing.ImageIcon	getIcon() Icon to represent this layer in user interfaces
java.lang.String	getName() Human-readable name
float	getOpacity() Retrieve the opacity for this layer - 0 means fully transparent and 1 means opaque.
void	init(ConsoleLayout console) Initialize this layer by passing a Console instance
void	parseXmlElement(org.dom4j.Element elem) Load configuration from a partial XML tree
void	setOpacity(float opacity) Set layer opacity
boolean	userControlsOpacity() Should the user be able to control the opacity of this layer?

Methods inherited from interface pt.lsts.neptus.renderer2d.Renderer2DPainter

paint

Methods inherited from interface pt.lsts.neptus.gui.PropertiesProvider

getProperties, getPropertiesDialogTitle, getPropertiesErrors, setProperties

Method Detail

init

void init(ConsoleLayout console)

Initialize this layer by passing a Console instance

Parameters:

console - The Console where this IMapLayer has been added to

clean

void clean()

This layer has been removed or the MapPanel was closed.

userControlsOpacity

boolean userControlsOpacity()

Should the user be able to control the opacity of this layer?

Returns:

true for allowing the user to control this layer visibility or false if opacity should be controlled only via code.

getOpacity

float getOpacity()

Retrieve the opacity for this layer - 0 means fully transparent and 1 means opaque.

Returns:

The opacity of this layer (0 = transparent, 1 = opaque)

setOpacity

void setOpacity(float opacity)

Set layer opacity

Parameters:

opacity - The opacity of this layer

asElement

org.dom4j.Element asElement(java.lang.String rootElement)

Save the configurations of this layer as XML

Parameters:

rootElement - The name of the root XML tag to use when saving

Returns:

The XML configuration of this tag

parseXmlElement

void parseXmlElement(org.dom4j.Element elem)

Load configuration from a partial XML tree

Parameters:

xml - An XML string having as top-level element the tag relative to this IMapLayer

getName

java.lang.String getName()

Human-readable name

Returns:

A human-readable name for this layer

getIcon

javax.swing.ImageIcon getIcon()

Icon to represent this layer in user interfaces

Returns:

An image icon (16x16 pixels)