pt.lsts.neptus.console

Class ConsoleLayer

java.lang.Object

pt.lsts.neptus.console.AbstractConsolePlugin

pt.lsts.neptus.console.ConsoleLayer

All Implemented Interfaces:

IConsoleLayer, PropertiesProvider, Renderer2DPainter

Direct Known Subclasses:

DesiredPathLayer, MapShortcutsLayer, PlanSimulationLayer

public abstract class ConsoleLayer
extends AbstractConsolePlugin
implements IConsoleLayer

Author:

zp

Constructor Summary

Constructors

Constructor and Description
ConsoleLayer()

Method Summary

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.
abstract void	cleanLayer()
java.awt.AlphaComposite	getComposite()
float	getOpacity() Retrieve the opacity for this layer - 0 means fully transparent and 1 means opaque.
abstract void	initLayer()
protected void	initPlugin(ConsoleLayout console) Use this to setup your plugin before the register of the IPeriodicUpdates and Message callbacks.
boolean	isVisible()
void	paint(java.awt.Graphics2D g, StateRenderer2D renderer)
void	parseXmlElement(org.dom4j.Element elem) Load configuration from a partial XML tree
void	setOpacity(float opacity) Set layer opacity
void	setVisible(boolean visible)
abstract boolean	userControlsOpacity() Should the user be able to control the opacity of this layer?

Methods inherited from class pt.lsts.neptus.console.AbstractConsolePlugin

getConsole, getIcon, getName, getProperties, getPropertiesDialogTitle, getPropertiesErrors, getState, init, propertiesChanged, setProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface pt.lsts.neptus.console.IConsoleLayer

getIcon, getName, init

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

getProperties, getPropertiesDialogTitle, getPropertiesErrors, setProperties

Constructor Detail

ConsoleLayer

public ConsoleLayer()

Method Detail

userControlsOpacity

public abstract boolean userControlsOpacity()

Description copied from interface: IConsoleLayer

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

Specified by:

userControlsOpacity in interface IConsoleLayer

Returns:

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

initLayer

public abstract void initLayer()

cleanLayer

public abstract void cleanLayer()

getOpacity

public float getOpacity()

Description copied from interface: IConsoleLayer

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

Specified by:

getOpacity in interface IConsoleLayer

Returns:

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

setVisible

public void setVisible(boolean visible)

isVisible

public boolean isVisible()

setOpacity

public void setOpacity(float opacity)

Description copied from interface: IConsoleLayer

Set layer opacity

Specified by:

setOpacity in interface IConsoleLayer

Parameters:

opacity - The opacity of this layer

initPlugin

protected final void initPlugin(ConsoleLayout console)

Description copied from class: AbstractConsolePlugin

Use this to setup your plugin before the register of the IPeriodicUpdates and Message callbacks.

Specified by:

initPlugin in class AbstractConsolePlugin

clean

public final void clean()

Description copied from interface: IConsoleLayer

This layer has been removed or the MapPanel was closed.

Specified by:

clean in interface IConsoleLayer

Overrides:

clean in class AbstractConsolePlugin

getComposite

public java.awt.AlphaComposite getComposite()

paint

public void paint(java.awt.Graphics2D g,
                  StateRenderer2D renderer)

Specified by:

paint in interface Renderer2DPainter

asElement

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

Description copied from interface: IConsoleLayer

Save the configurations of this layer as XML

Specified by:

asElement in interface IConsoleLayer

Overrides:

asElement in class AbstractConsolePlugin

Parameters:

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

Returns:

The XML configuration of this tag

parseXmlElement

public void parseXmlElement(org.dom4j.Element elem)

Description copied from interface: IConsoleLayer

Load configuration from a partial XML tree

Specified by:

parseXmlElement in interface IConsoleLayer

Overrides:

parseXmlElement in class AbstractConsolePlugin