pt.lsts.neptus.console

Class ConsolePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

pt.lsts.neptus.console.ConsolePanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, MainVehicleChangeListener, PropertiesProvider, pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,pt.lsts.imc.IMCMessage>, XmlInOutMethods, XmlOutputMethods

Direct Known Subclasses:

AbortPanel, AlternativeCompass, AreaCoveragePlanner, ChronometerPlugin, CommandPlanner, ConsoleEvents, ContainerSubPanel, ControllerPanel, DistancesLayer, DummySubPanel, EmergencyControlPanel, EntityStatePanel, FormationPlanner, GPSPanel, HTTPControls, ImcParametersSubPanel, InteractionAdapter, JVideoPanelConsole, LockConsolePanel, LogBookPanel, MapPanel, MissionTreePanel, MultiVehiclePlanner, MultiVehiclePlanOverlay, MyLocationDisplay, PathControlLayer, PlanControlPanel, PlanControlStatePanel, PlanExecutionPreview, PlanStatistics, PluginManager, RemoteOperationControlMode, SettingsWindow, SideState2DPanelConsole, SimpleMenuAction, SimpleRendererInteraction, SystemConfiguration, SystemsList, UavPiccoloControl, VehicleStateMonitor

public abstract class ConsolePanel
extends javax.swing.JPanel
implements PropertiesProvider, XmlInOutMethods, pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,pt.lsts.imc.IMCMessage>, MainVehicleChangeListener

Author:

Rui Gonçalves, ZP

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

Modifier and Type	Field and Description
protected javax.swing.JDialog	dialog

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

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
ConsolePanel(ConsoleLayout console)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activateComponents()
javax.swing.JCheckBoxMenuItem	addCheckMenuItem(java.lang.String itemPath, javax.swing.ImageIcon icon, CheckMenuChangeListener checkListener) Creates and retrieves a console check menu item (toggle)
javax.swing.JMenu	addMenu(java.lang.String itemPath, javax.swing.ImageIcon icon)
javax.swing.JMenuItem	addMenuItem(java.lang.String itemPath, javax.swing.ImageIcon icon, java.awt.event.ActionListener actionListener) Creates and retrieves a console menu item
org.dom4j.Document	asDocument()
org.dom4j.Document	asDocument(java.lang.String rootElementName)
org.dom4j.Element	asElement()
org.dom4j.Element	asElement(java.lang.String rootElementName)
java.lang.String	asXML() Este problema foi resolvido com a versão 1.6.1 do DOM4J.
java.lang.String	asXML(java.lang.String rootElementName) Este problema foi resolvido com a versão 1.6.1 do DOM4J.
void	clean() Empty implementation.
abstract void	cleanSubPanel()
protected void	deactivateComponents()
protected ConsolePanel[]	getChildren()
ConsoleLayout	getConsole()
java.lang.String	getDescription()
boolean	getEditMode()
javax.swing.ImageIcon	getImageIcon()
protected MainPanel	getMainpanel()
java.lang.String	getMainVehicleId()
java.lang.String	getName()
com.l2fprod.common.propertysheet.DefaultProperty[]	getProperties()
java.lang.String	getPropertiesDialogTitle()
java.lang.String[]	getPropertiesErrors(com.l2fprod.common.propertysheet.Property[] properties)
protected pt.lsts.imc.state.ImcSysState	getState()
boolean	getVisibility()
void	inDocument(org.dom4j.Document d)
void	inElement(org.dom4j.Element e)
void	init() Empty implementation.
abstract void	initSubPanel()
boolean	isFixedPosition()
boolean	isFixedSize()
boolean	isResizable()
void	mainVehicleChange(java.lang.String id) If you need to react to main vehicle change override #mainVehicleChangeNotification(String) instead.
void	onMessage(pt.lsts.neptus.messages.listener.MessageInfo arg0, pt.lsts.imc.IMCMessage arg1)
protected void	parentResized(java.awt.Dimension oldSize, java.awt.Dimension newSize)
void	parseXML(java.lang.String str)
void	post(java.lang.Object event) Alias method to send console events
protected void	recalculateRelativePosAndSize()
void	removeCheckMenuItem(java.lang.String itemPath)
void	removeMenuItem(java.lang.String itemPath)
boolean	send(pt.lsts.imc.IMCMessage message) Send IMCMessage to Main System
boolean	send(java.lang.String destination, pt.lsts.imc.IMCMessage message) Send IMCMessage
void	sendViaIridium(java.lang.String destination, pt.lsts.imc.IMCMessage message)
protected void	setEditMode(boolean b)
void	setFixedPosition(boolean fixedPosition)
void	setFixedSize(boolean fixedSize)
protected void	setPopupPosition(Popup.POSITION popupPosition)
void	setProperties(com.l2fprod.common.propertysheet.Property[] properties)
void	setResizable(boolean resizable)
void	setVisibility(boolean visibility) Use this method to set the panel invisible (only visible at edition).
void	XML_ChildsRead(org.dom4j.Element e)
void	XML_ChildsWrite(org.dom4j.Element e)
void	XML_PropertiesRead(org.dom4j.Element e)
void	XML_PropertiesWrite(org.dom4j.Element e)

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, 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

Field Detail

dialog

protected javax.swing.JDialog dialog

Constructor Detail

ConsolePanel

public ConsolePanel(ConsoleLayout console)

Method Detail

activateComponents

protected final void activateComponents()

addCheckMenuItem

public javax.swing.JCheckBoxMenuItem addCheckMenuItem(java.lang.String itemPath,
                                             javax.swing.ImageIcon icon,
                                             CheckMenuChangeListener checkListener)

Creates and retrieves a console check menu item (toggle)

Parameters:

itemPath - The path to the menu item separated by ">". Examples:

"Tools > Local Network > Test Network"

"Tools>Test Network"

icon - The icon to be used in the menu item.
Size is automatically adjusted to 16x16 pixels.

actionListener - The CheckMenuChangeListener that will be warned on menu selection changes

Returns:

The created JCheckMenuItem or null if an error as occurrred.

addMenu

public javax.swing.JMenu addMenu(java.lang.String itemPath,
                        javax.swing.ImageIcon icon)

addMenuItem

public javax.swing.JMenuItem addMenuItem(java.lang.String itemPath,
                                javax.swing.ImageIcon icon,
                                java.awt.event.ActionListener actionListener)

Creates and retrieves a console menu item

Parameters:

itemPath - The path to the menu item separated by ">". Examples:

"Tools > Local Network > Test Network"

"Tools>Test Network"

icon - The icon to be used in the menu item.
Size is automatically adjusted to 16x16 pixels.

actionListener - The ActionListener that will be warned on menu activation

Returns:

The created JMenuItem or null if an error as occurred.

asDocument

public org.dom4j.Document asDocument()

Specified by:

asDocument in interface XmlOutputMethods

Returns:

asDocument

public org.dom4j.Document asDocument(java.lang.String rootElementName)

Specified by:

asDocument in interface XmlOutputMethods

Returns:

asElement

public org.dom4j.Element asElement()

Specified by:

asElement in interface XmlOutputMethods

Returns:

asElement

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

Specified by:

asElement in interface XmlOutputMethods

Returns:

asXML

public java.lang.String asXML()

Description copied from interface: XmlOutputMethods

Este problema foi resolvido com a versão 1.6.1 do DOM4J.

Atenção ao usar este método com o método FileUtil.saveToFile(String, String) e afins. Isto porque ao gravar como UTF-8 os caracteres são adulterados guardando por exemplo "é" em 2 caracteres (ou seja pega nos dois caracteres UTF-8 e transforma-os em 2 UTF-8s).

Specified by:

asXML in interface XmlOutputMethods

Returns:

asXML

public java.lang.String asXML(java.lang.String rootElementName)

Description copied from interface: XmlOutputMethods

Este problema foi resolvido com a versão 1.6.1 do DOM4J.

Atenção ao usar este método com o método FileUtil.saveToFile(String, String) e afins. Isto porque ao gravar como UTF-8 os caracteres são adulterados guardando por exemplo "é" em 2 caracteres (ou seja pega nos dois caracteres UTF-8 e transforma-os em 2 UTF-8s).

Specified by:

asXML in interface XmlOutputMethods

Returns:

clean

public void clean()

Empty implementation. This is called when the console wants to remove the panel from the console (override it if needed to properly disposal of the component).

cleanSubPanel

public abstract void cleanSubPanel()

deactivateComponents

protected final void deactivateComponents()

getChildren

protected final ConsolePanel[] getChildren()

getConsole

public final ConsoleLayout getConsole()

getDescription

public java.lang.String getDescription()

getEditMode

public final boolean getEditMode()

getImageIcon

public javax.swing.ImageIcon getImageIcon()

getMainpanel

protected final MainPanel getMainpanel()

getMainVehicleId

public java.lang.String getMainVehicleId()

Returns:

the mainVehicleId

getName

public final java.lang.String getName()

Overrides:

getName in class java.awt.Component

getProperties

public com.l2fprod.common.propertysheet.DefaultProperty[] getProperties()

Specified by:

getProperties in interface PropertiesProvider

getPropertiesDialogTitle

public final java.lang.String getPropertiesDialogTitle()

Specified by:

getPropertiesDialogTitle in interface PropertiesProvider

getPropertiesErrors

public java.lang.String[] getPropertiesErrors(com.l2fprod.common.propertysheet.Property[] properties)

Specified by:

getPropertiesErrors in interface PropertiesProvider

getState

protected final pt.lsts.imc.state.ImcSysState getState()

getVisibility

public boolean getVisibility()

inDocument

public void inDocument(org.dom4j.Document d)

Specified by:

inDocument in interface XmlInOutMethods

inElement

public void inElement(org.dom4j.Element e)

Specified by:

inElement in interface XmlInOutMethods

init

public void init()

Empty implementation. This method is called after console is completely loaded with all panels (override it if needed).

initSubPanel

public abstract void initSubPanel()

parseXML

public void parseXML(java.lang.String str)

Specified by:

parseXML in interface XmlInOutMethods

isFixedPosition

public boolean isFixedPosition()

isFixedSize

public boolean isFixedSize()

isResizable

public boolean isResizable()

mainVehicleChange

public final void mainVehicleChange(java.lang.String id)

If you need to react to main vehicle change override #mainVehicleChangeNotification(String) instead.

Specified by:

mainVehicleChange in interface MainVehicleChangeListener

See Also:

The {@link #mainVehicleChangeNotification(String)} is called between the removal and addition of the new vehicle listener The {@link #mainVehicleId} is changed before this call.

onMessage

public final void onMessage(pt.lsts.neptus.messages.listener.MessageInfo arg0,
             pt.lsts.imc.IMCMessage arg1)

Specified by:

onMessage in interface pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,pt.lsts.imc.IMCMessage>

parentResized

protected final void parentResized(java.awt.Dimension oldSize,
                 java.awt.Dimension newSize)

post

public void post(java.lang.Object event)

Alias method to send console events

Parameters:

event - The Event to be posted to the console and forwarded to any subscribers

See Also:

Subscribe

recalculateRelativePosAndSize

protected final void recalculateRelativePosAndSize()

removeCheckMenuItem

public void removeCheckMenuItem(java.lang.String itemPath)

removeMenuItem

public void removeMenuItem(java.lang.String itemPath)

send

public boolean send(pt.lsts.imc.IMCMessage message)

Send IMCMessage to Main System

Parameters:

message -

Returns:

sendViaIridium

public void sendViaIridium(java.lang.String destination,
                  pt.lsts.imc.IMCMessage message)

send

public boolean send(java.lang.String destination,
           pt.lsts.imc.IMCMessage message)

Send IMCMessage

Parameters:

destination -

message -

Returns:

setEditMode

protected void setEditMode(boolean b)

setFixedPosition

public void setFixedPosition(boolean fixedPosition)

setFixedSize

public void setFixedSize(boolean fixedSize)

setPopupPosition

protected void setPopupPosition(Popup.POSITION popupPosition)

setProperties

public void setProperties(com.l2fprod.common.propertysheet.Property[] properties)

Specified by:

setProperties in interface PropertiesProvider

setResizable

public void setResizable(boolean resizable)

setVisibility

public void setVisibility(boolean visibility)

Use this method to set the panel invisible (only visible at edition). Useful for daemons

Parameters:

visibility - Whether this panel is to be visible or not. Panels are always visible at edit time

XML_ChildsRead

public void XML_ChildsRead(org.dom4j.Element e)

XML_ChildsWrite

public void XML_ChildsWrite(org.dom4j.Element e)

XML_PropertiesRead

public void XML_PropertiesRead(org.dom4j.Element e)

XML_PropertiesWrite

public void XML_PropertiesWrite(org.dom4j.Element e)