org.sbml.jsbml.ext.render

Class RelAbsVector

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.ext.render.RelAbsVector

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, TreeNodeWithChangeSupport

public class RelAbsVector
extends AbstractTreeNode

Implements the RelAbsVector-datatype defined in the render-specification: A RelAbsVector encodes a single number as a combination of an absolute and a relative part: "a + r%", where the relative part is with respect to some surrounding space (like a boundingBox).
This implementation deviates from the one in libSBML in that the support for ,Coordinate' get/set/isSet is reduced

Author:

DavidVetter

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor and Description
RelAbsVector()
RelAbsVector(double absolute) Set only the absolute, but not the relative part, to an initial value
RelAbsVector(double absolute, double relative) Set both the relative and absolute parts to initial values
RelAbsVector(RelAbsVector original) Copy-constructor
RelAbsVector(String coordinate) Set from a XML-String in the format "a" or "r%" or "a+r%" or "a-r%", as described in the render-specification

Method Summary

Modifier and Type	Method and Description
RelAbsVector	clone()
boolean	equals(Object obj)
double	getAbsoluteValue()
boolean	getAllowsChildren()
TreeNode	getChildAt(int childIndex)
int	getChildCount()
String	getCoordinate() Produces a string of the format "a" or "r%" or "a+r%" or "a-r%" as specified in the render-documentation.
double	getRelativeValue()
int	hashCode()
boolean	isSetAbsoluteValue()
boolean	isSetRelativeValue()
void	setAbsoluteValue(double absolute) Sets absolute part to new value and fires appropriate event
boolean	setCoordinate(String coordinates) Sets the relative and absolute value based on a String-encoding (like "1", "30%" or "50-20%"; as defined in the render-specification) If the String does not represent a valid value, relative and absolute value are set to NaN
void	setRelativeValue(double relative) Sets relative part to new value and fires appropriate event
String	toString() Produces a string for debugging etc.
boolean	unsetAbsoluteValue() Tries to unset the absolute value
boolean	unsetRelativeValue() Tries to unset the relative value

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getParent, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, notifyChildChange, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RelAbsVector

public RelAbsVector()

RelAbsVector

public RelAbsVector(RelAbsVector original)

Copy-constructor

Parameters:

original -

RelAbsVector

public RelAbsVector(double absolute)

Set only the absolute, but not the relative part, to an initial value

Parameters:

absolute - coordinate-value (in pt)

RelAbsVector

public RelAbsVector(double absolute,
                    double relative)

Set both the relative and absolute parts to initial values

Parameters:

absolute - coordinate-value (in pt)

relative - in % of some reference size (of the enclosing BoundingBox), relative=75 means 75% (i.e. 0.75)

RelAbsVector

public RelAbsVector(String coordinate)

Set from a XML-String in the format "a" or "r%" or "a+r%" or "a-r%", as described in the render-specification

Parameters:

coordinate - String encoding of a RelAbsVector. If invalid, both absolute and relative part are set to NaN (i.e. unset)

Method Detail

clone

public RelAbsVector clone()

Overrides:

clone in class AbstractTreeNode

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractTreeNode

getAbsoluteValue

public double getAbsoluteValue()

Returns:

the absolute part/value

getRelativeValue

public double getRelativeValue()

Returns:

the relative part/value (in %, i.e. a return of 100d means 100%)

setAbsoluteValue

public void setAbsoluteValue(double absolute)

Sets absolute part to new value and fires appropriate event

Parameters:

absolute - the new absolute value to be taken

setRelativeValue

public void setRelativeValue(double relative)

Sets relative part to new value and fires appropriate event

Parameters:

relative - the new relative value to be taken (in percent, i.e. relative=100d means 100%)

isSetAbsoluteValue

public boolean isSetAbsoluteValue()

Returns:

whether the absolute value is set to a number

isSetRelativeValue

public boolean isSetRelativeValue()

Returns:

whether the relative value is set to a number

unsetAbsoluteValue

public boolean unsetAbsoluteValue()

Tries to unset the absolute value

Returns:

whether the absolute value could indeed be unset

unsetRelativeValue

public boolean unsetRelativeValue()

Tries to unset the relative value

Returns:

whether the relative value could indeed be unset

setCoordinate

public boolean setCoordinate(String coordinates)

Sets the relative and absolute value based on a String-encoding (like "1", "30%" or "50-20%"; as defined in the render-specification)
If the String does not represent a valid value, relative and absolute value are set to NaN

Parameters:

coordinates - a RelAbsVector string

Returns:

Whether the string was valid

getCoordinate

public String getCoordinate()

Produces a string of the format "a" or "r%" or "a+r%" or "a-r%" as specified in the render-documentation.

Returns:

the XML-string-encoding of this RelAbsVector

toString

public String toString()

Produces a string for debugging etc. This is not the XML-string-encoding for render, which can be retrieved by getCoordinate()

Overrides:

toString in class AbstractTreeNode

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTreeNode

getChildAt

public TreeNode getChildAt(int childIndex)

getChildCount

public int getChildCount()

getAllowsChildren

public boolean getAllowsChildren()