AbstractElement (Neptus Package API)

java.lang.Object
- pt.lsts.neptus.types.map.AbstractElement

All Implemented Interfaces:

java.awt.event.ActionListener, java.lang.Comparable<AbstractElement>, java.util.EventListener, XmlInputMethods, XmlOutputMethods

Direct Known Subclasses:

GeometryElement, HomeReferenceElement, ImageElement, MarkElement, Model3DElement, PathElement, PlanElement, ScatterPointsElement, SimpleMapElement, TransponderElement
```
public abstract class AbstractElement
extends java.lang.Object
implements java.awt.event.ActionListener, java.lang.Comparable<AbstractElement>, XmlOutputMethods, XmlInputMethods
```
This is the superclass of all objects that can be placed on a map Refactored in 17/11/2006.

Author:

Paulo Dias, Zé Carlos

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractElement.ELEMENT_TYPE

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractElement.ELEMENT_TYPE`

Field Summary

Fields
Modifier and Type	Field and Description
`protected LocationType`	`centerLocation`
`boolean`	`copyChars`
`protected static java.lang.String`	`DEFAULT_ROOT_ELEMENT`
`protected javax.swing.JDialog`	`dialog`
`protected org.dom4j.Document`	`doc`
`protected static LocationType`	`guine`
`protected java.lang.String`	`id`
`protected boolean`	`isLoadOk`
`protected javax.swing.JTextField`	`objName`
`protected ParametersPanel`	`paramsPanel`
`protected boolean`	`selected`
`java.lang.String[]`	`takenNames`
`protected javax.swing.JTextField`	`transp`
`protected int`	`transparency`
`boolean`	`userCancel`

Constructor Summary

Constructors
Constructor and Description
`AbstractElement()` Creates a map element
`AbstractElement(MapGroup mg, MapType parentMap)`
`AbstractElement(java.lang.String xml)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(java.awt.event.ActionEvent action)` The actions are triggered by the dialog created for the object parameters
`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.
`int`	`compareTo(AbstractElement anotherMapObject)`
`abstract boolean`	`containsPoint(LocationType point, StateRenderer2D renderer)`
`LocationType`	`getCenterLocation()`
`AbstractElement`	`getClone()`
`abstract AbstractElement.ELEMENT_TYPE`	`getElementType()`
`java.lang.String`	`getId()`
`static java.util.Comparator`	`getIDComparator()`
`abstract int`	`getLayerPriority()` Returns the showing priority for this object (0 normal, <0 background, >0 on top)
`MapGroup`	`getMapGroup()`
`MissionType`	`getMissionType()`
`double[]`	`getNEDPosition()` Returns the offset from absolute 0 as double[3]: 0 - The offset (in the North direction) from absolut (0,0,0) 1 - The offset (in the East direction) from absolut (0,0,0) 2 - The offset (in the Down direction) from absolut (0,0,0)
`abstract ParametersPanel`	`getParametersPanel(boolean editable, MapType map)`
`MapType`	`getParentMap()`
`double`	`getPhi()`
`double`	`getPitch()`
`double`	`getPitchDeg()`
`double`	`getPitchRad()`
`double`	`getPsi()`
`double`	`getRoll()`
`double`	`getRollDeg()`
`double`	`getRollRad()`
`java.util.Vector<LocationType>`	`getShapePoints()`
`double`	`getTheta()`
`double`	`getTopHeight()`
`int`	`getTransparency()`
`abstract java.lang.String`	`getType()`
`double`	`getYaw()`
`double`	`getYawDeg()`
`double`	`getYawRad()`
`abstract void`	`initialize(ParametersPanel paramsPanel)`
`java.awt.Color`	`invertColor(java.awt.Color original)` Given a java.util.Color, returns its complementar color (negative)
`boolean`	`isLoadOk()`
`boolean`	`isSelected()`
`boolean`	`isUserCancel()`
`boolean`	`load(org.dom4j.Element elem)` Should set `XmlInputMethods.isLoadOk()` return value.
`boolean`	`load(java.lang.String xml)` Should set `XmlInputMethods.isLoadOk()` return value.
`abstract void`	`paint(java.awt.Graphics2D g, StateRenderer2D renderer, double rotation)`
`void`	`setCenterLocation(LocationType centralLocation)`
`void`	`setId(java.lang.String id)`
`void`	`setMapGroup(MapGroup mapGroup)`
`void`	`setMissionType(MissionType missionType)`
`void`	`setParentMap(MapType parentMap)`
`void`	`setPhi(double phi)`
`void`	`setPitch(double theta)`
`void`	`setPitchDeg(double pitch)`
`void`	`setPsi(double psi)`
`void`	`setRoll(double phi)`
`void`	`setRollDeg(double roll)`
`void`	`setSelected(boolean selected)`
`void`	`setTakenNames(java.lang.String[] takenNames)` Sets the currently taken object names (ids)
`void`	`setTheta(double theta)`
`void`	`setTransparency(int transparency)`
`void`	`setYaw(double psi)`
`void`	`setYawDeg(double yaw)`
`void`	`showParametersDialog(java.awt.Component parentComp, java.lang.String[] takenNames, MapType map, boolean editable)` Creates a shows a parameters dialog for the current object The user can chage the parameters of the current object here.
`java.lang.String`	`toString()` Returns the result of getName() - the default implementation returns the field name

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - guine
```
protected static final LocationType guine
```
  - isLoadOk
```
protected boolean isLoadOk
```
  - DEFAULT_ROOT_ELEMENT
```
protected static final java.lang.String DEFAULT_ROOT_ELEMENT
```
    See Also:
    
    Constant Field Values
  - transparency
```
protected int transparency
```
  - centerLocation
```
protected LocationType centerLocation
```
  - doc
```
protected org.dom4j.Document doc
```
  - id
```
protected java.lang.String id
```
  - selected
```
protected boolean selected
```
  - paramsPanel
```
protected ParametersPanel paramsPanel
```
  - userCancel
```
public boolean userCancel
```
  - copyChars
```
public boolean copyChars
```
  - takenNames
```
public java.lang.String[] takenNames
```
  - dialog
```
protected javax.swing.JDialog dialog
```
  - objName
```
protected javax.swing.JTextField objName
```
  - transp
```
protected javax.swing.JTextField transp
```
- Constructor Detail
  - AbstractElement
```
public AbstractElement()
```
    Creates a map element
  - AbstractElement
```
public AbstractElement(java.lang.String xml)
```
    Parameters:
    
    xml -
  - AbstractElement
```
public AbstractElement(MapGroup mg,
                       MapType parentMap)
```
- Method Detail
  - paint
```
public abstract void paint(java.awt.Graphics2D g,
                           StateRenderer2D renderer,
                           double rotation)
```
  - getParametersPanel
```
public abstract ParametersPanel getParametersPanel(boolean editable,
                                                   MapType map)
```
  - initialize
```
public abstract void initialize(ParametersPanel paramsPanel)
```
  - containsPoint
```
public abstract boolean containsPoint(LocationType point,
                                      StateRenderer2D renderer)
```
  - getElementType
```
public abstract AbstractElement.ELEMENT_TYPE getElementType()
```
  - getLayerPriority
```
public abstract int getLayerPriority()
```
    Returns the showing priority for this object (0 normal, <0 background, >0 on top)
    
    Returns:
    
    The layer priority for this object
  - isLoadOk
```
public boolean isLoadOk()
```
    Specified by:
    
    isLoadOk in interface XmlInputMethods
    
    Returns:
    
    If the load of the XML was successful.
  - load
```
public boolean load(java.lang.String xml)
```
    Description copied from interface: XmlInputMethods
    
    Should set XmlInputMethods.isLoadOk() return value.
    
    Specified by:
    
    load in interface XmlInputMethods
    
    Parameters:
    
    xml -
    
    Returns:
  - load
```
public boolean load(org.dom4j.Element elem)
```
    Description copied from interface: XmlInputMethods
    
    Should set XmlInputMethods.isLoadOk() return value.
    
    Specified by:
    
    load in interface XmlInputMethods
    
    Parameters:
    
    elem -
    
    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:
  - 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:
  - 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:
  - getType
```
public abstract java.lang.String getType()
```
    Returns:
  - getTransparency
```
public int getTransparency()
```
    Returns:
  - setTransparency
```
public void setTransparency(int transparency)
```
    Parameters:
    
    transparency -
  - getPhi
```
public double getPhi()
```
    Returns:
    
    Returns the phi.
  - setPhi
```
public void setPhi(double phi)
```
    Parameters:
    
    phi - The phi to set.
  - getRoll
```
public double getRoll()
```
    Returns:
    
    Returns the phi.
  - setRoll
```
public void setRoll(double phi)
```
    Parameters:
    
    phi - The phi to set.
  - getTheta
```
public double getTheta()
```
    Returns:
    
    Returns the theta.
  - setTheta
```
public void setTheta(double theta)
```
    Parameters:
    
    theta - The theta to set.
  - getPitch
```
public double getPitch()
```
    Returns:
    
    Returns the theta.
  - setPitch
```
public void setPitch(double theta)
```
    Parameters:
    
    theta - The theta to set.
  - getPsi
```
public double getPsi()
```
    Returns:
    
    Returns the psi.
  - setPsi
```
public void setPsi(double psi)
```
    Parameters:
    
    psi - The psi to set.
  - getYaw
```
public double getYaw()
```
    Returns:
    
    Returns the psi.
  - setYaw
```
public void setYaw(double psi)
```
    Parameters:
    
    psi - The psi to set.
  - setRollDeg
```
public void setRollDeg(double roll)
```
  - setPitchDeg
```
public void setPitchDeg(double pitch)
```
  - setYawDeg
```
public void setYawDeg(double yaw)
```
  - getRollRad
```
public double getRollRad()
```
    Returns:
    
    the current roll rotation in RADIANS!
  - getPitchRad
```
public double getPitchRad()
```
    Returns:
    
    the current pitch rotation in RADIANS!
  - getYawRad
```
public double getYawRad()
```
    Returns:
    
    the current yaw rotation in RADIANS!
  - getRollDeg
```
public double getRollDeg()
```
    Returns:
  - getPitchDeg
```
public double getPitchDeg()
```
    Returns:
  - getYawDeg
```
public double getYawDeg()
```
    Returns:
  - getTopHeight
```
public double getTopHeight()
```
  - getMapGroup
```
public MapGroup getMapGroup()
```
    Returns:
  - setMapGroup
```
public void setMapGroup(MapGroup mapGroup)
```
    Parameters:
    
    mapGroup -
  - setParentMap
```
public void setParentMap(MapType parentMap)
```
    Parameters:
    
    parentMap -
  - getParentMap
```
public MapType getParentMap()
```
    Returns:
  - getMissionType
```
public MissionType getMissionType()
```
    Returns:
  - setMissionType
```
public void setMissionType(MissionType missionType)
```
    Parameters:
    
    missionType -
  - compareTo
```
public int compareTo(AbstractElement anotherMapObject)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<AbstractElement>
  - getIDComparator
```
public static java.util.Comparator getIDComparator()
```
    Returns:
  - getCenterLocation
```
public LocationType getCenterLocation()
```
  - setCenterLocation
```
public void setCenterLocation(LocationType centralLocation)
```
  - getId
```
public java.lang.String getId()
```
  - setId
```
public void setId(java.lang.String id)
```
  - toString
```
public java.lang.String toString()
```
    Returns the result of getName() - the default implementation returns the field name
    
    Overrides:
    
    toString in class java.lang.Object
  - isSelected
```
public boolean isSelected()
```
  - setSelected
```
public void setSelected(boolean selected)
```
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent action)
```
    The actions are triggered by the dialog created for the object parameters
    
    Specified by:
    
    actionPerformed in interface java.awt.event.ActionListener
  - showParametersDialog
```
public void showParametersDialog(java.awt.Component parentComp,
                                 java.lang.String[] takenNames,
                                 MapType map,
                                 boolean editable)
```
    Creates a shows a parameters dialog for the current object The user can chage the parameters of the current object here.
    
    Parameters:
    
    takenNames -
  - isUserCancel
```
public boolean isUserCancel()
```
    Returns:
  - setTakenNames
```
public void setTakenNames(java.lang.String[] takenNames)
```
    Sets the currently taken object names (ids)
    
    Parameters:
    
    takenNames - An array of String with the all the existing object names (ids)
  - invertColor
```
public java.awt.Color invertColor(java.awt.Color original)
```
    Given a java.util.Color, returns its complementar color (negative)
    
    Parameters:
    
    original - A java.util.Color
    
    Returns:
    
    A color calculated by inverting all the color components (RGB)
  - getShapePoints
```
public java.util.Vector<LocationType> getShapePoints()
```
  - getNEDPosition
```
public double[] getNEDPosition()
```
    Returns the offset from absolute 0 as double[3]:
    
    0 - The offset (in the North direction) from absolut (0,0,0)
    1 - The offset (in the East direction) from absolut (0,0,0)
    2 - The offset (in the Down direction) from absolut (0,0,0)
    
    Returns:
    
    A 3 component absolute offset
  - getClone
```
public AbstractElement getClone()
                         throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception

Class AbstractElement

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

guine

isLoadOk

DEFAULT_ROOT_ELEMENT

transparency

centerLocation

doc

id

selected

paramsPanel

userCancel

copyChars

takenNames

dialog

objName

transp

Constructor Detail

AbstractElement

AbstractElement

AbstractElement

Method Detail

paint

getParametersPanel

initialize

containsPoint

getElementType

getLayerPriority

isLoadOk

load

load

asXML

asXML

asElement

asElement

asDocument

asDocument

getType

getTransparency

setTransparency

getPhi

setPhi

getRoll

setRoll

getTheta

setTheta

getPitch

setPitch

getPsi

setPsi

getYaw

setYaw

setRollDeg

setPitchDeg

setYawDeg

getRollRad

getPitchRad

getYawRad

getRollDeg

getPitchDeg

getYawDeg

getTopHeight

getMapGroup

setMapGroup

setParentMap

getParentMap

getMissionType

setMissionType

compareTo

getIDComparator

getCenterLocation

setCenterLocation

getId

setId

toString