Package org.sbml.jsbml.ext.render

Class Text

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.render.Transformation

org.sbml.jsbml.ext.render.Transformation2D

org.sbml.jsbml.ext.render.GraphicalPrimitive1D

org.sbml.jsbml.ext.render.Text

All Implemented Interfaces:

FontRenderStyle, Point3D

public class Text
extends GraphicalPrimitive1D
implements FontRenderStyle, Point3D

Since:

1.0

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph, Onur Özel, David Emanuel Vetter

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Fields inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive1D

stroke, strokeDashArray, strokeWidth

Fields inherited from class org.sbml.jsbml.ext.render.Transformation

transform

Constructor Summary

Constructors

Constructor	Description
Text()
Text(int level, int version)
Text(Text obj)

Method Summary

Modifier and Type	Method	Description
Text	clone()
boolean	equals(java.lang.Object obj)
java.lang.String	getFontFamily()
RelAbsVector	getFontSize()
java.lang.String	getText()
HTextAnchor	getTextAnchor()
VTextAnchor	getVTextAnchor()
RelAbsVector	getX()
RelAbsVector	getY()
RelAbsVector	getZ()
int	hashCode()
void	initDefaults()	Initializes the default values using the namespace.
boolean	isFontStyleItalic()
boolean	isFontWeightBold()
boolean	isSetFontFamily()
boolean	isSetFontSize()
boolean	isSetFontStyleItalic()
boolean	isSetFontWeightBold()
boolean	isSetText()	Checks whether the text-field has been set.
boolean	isSetTextAnchor()
boolean	isSetVTextAnchor()
boolean	isSetX()
boolean	isSetY()
boolean	isSetZ()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
void	setFontFamily(java.lang.String fontFamily)	Set the value of fontFamily
void	setFontFamily(FontFamily fontFamily)	Set the value of fontFamily by using a FontFamily type.
void	setFontSize(RelAbsVector fontSize)	Set the value of fontSize
void	setFontStyleItalic(boolean fontStyleItalic)	Set the value of fontStyleItalic
void	setFontWeightBold(boolean fontWeightBold)	Set the value of fontWeightBold
void	setText(java.lang.String text)	Set the value of the text field (and fire appropriate property-change event)
void	setTextAnchor(HTextAnchor textAnchor)	Set the value of textAnchor
void	setVTextAnchor(VTextAnchor vTextAnchor)	Set the value of VTextAnchor
void	setX(RelAbsVector x)	Set the value of x
void	setY(RelAbsVector y)	Set the value of y
void	setZ(RelAbsVector z)	Set the value of z
java.lang.String	toString()
boolean	unsetFontFamily()	Unsets the variable fontFamily
boolean	unsetFontSize()	Unsets the variable fontSize
boolean	unsetFontStyleItalic()	Unsets the variable fontStyleItalic
boolean	unsetFontWeightBold()	Unsets the variable fontWeightBold
boolean	unsetText()	Unsets the text and fires appropriate change event
boolean	unsetTextAnchor()	Unsets the variable textAnchor
boolean	unsetVTextAnchor()	Unsets the variable VTextAnchor
boolean	unsetX()	Unsets the variable x
boolean	unsetY()	Unsets the variable y
boolean	unsetZ()	Unsets the variable z
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkIdentifier, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

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

Methods inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive1D

addStrokeDash, getStroke, getStrokeDash, getStrokeDashArray, getStrokeWidth, isSetStroke, isSetStrokeDashArray, isSetStrokeWidth, setStroke, setStrokeDashArray, setStrokeDashArray, setStrokeWidth, unsetStroke, unsetStrokeDashArray, unsetStrokeWidth

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sbml.jsbml.SBase

removeTreeNodeChangeListener

Methods inherited from class org.sbml.jsbml.ext.render.Transformation

isSetTransform, setTransform

Methods inherited from class org.sbml.jsbml.ext.render.Transformation2D

getTransform, unsetTransform

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Constructor Detail

Text

public Text()

Text

public Text(int level,
            int version)

Text

public Text(Text obj)

Method Detail

clone

public Text clone()

Overrides:

clone in class GraphicalPrimitive1D

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

Overrides:

initDefaults in class GraphicalPrimitive1D

getFontFamily

public java.lang.String getFontFamily()

Specified by:

getFontFamily in interface FontRenderStyle

Returns:

the value of fontFamily

getFontSize

public RelAbsVector getFontSize()

Specified by:

getFontSize in interface FontRenderStyle

Returns:

the value of fontSize

getText

public java.lang.String getText()

Returns:

the text to be displayed by this

getTextAnchor

public HTextAnchor getTextAnchor()

Specified by:

getTextAnchor in interface FontRenderStyle

Returns:

the value of textAnchor

getVTextAnchor

public VTextAnchor getVTextAnchor()

Specified by:

getVTextAnchor in interface FontRenderStyle

Returns:

the value of VTextAnchor

getX

public RelAbsVector getX()

Specified by:

getX in interface Point3D

Returns:

the value of x

getY

public RelAbsVector getY()

Specified by:

getY in interface Point3D

Returns:

the value of y

getZ

public RelAbsVector getZ()

Specified by:

getZ in interface Point3D

Returns:

the value of z

isFontStyleItalic

public boolean isFontStyleItalic()

Specified by:

isFontStyleItalic in interface FontRenderStyle

Returns:

the value of fontStyleItalic

isFontWeightBold

public boolean isFontWeightBold()

Specified by:

isFontWeightBold in interface FontRenderStyle

Returns:

the value of fontWeightBold

isSetFontFamily

public boolean isSetFontFamily()

Specified by:

isSetFontFamily in interface FontRenderStyle

Returns:

whether fontFamily is set

isSetFontSize

public boolean isSetFontSize()

Specified by:

isSetFontSize in interface FontRenderStyle

Returns:

whether fontSize is set

isSetFontStyleItalic

public boolean isSetFontStyleItalic()

Specified by:

isSetFontStyleItalic in interface FontRenderStyle

Returns:

whether fontStyleItalic is set

isSetFontWeightBold

public boolean isSetFontWeightBold()

Specified by:

isSetFontWeightBold in interface FontRenderStyle

Returns:

whether fontWeightBold is set

isSetText

public boolean isSetText()

Checks whether the text-field has been set.
Note: Deviating from libSBML, the empty string "" is a valid, set value of text

Returns:

Whether the text-field has been set

isSetTextAnchor

public boolean isSetTextAnchor()

Specified by:

isSetTextAnchor in interface FontRenderStyle

Returns:

whether textAnchor is set

isSetVTextAnchor

public boolean isSetVTextAnchor()

Specified by:

isSetVTextAnchor in interface FontRenderStyle

Returns:

whether VTextAnchor is set

isSetX

public boolean isSetX()

Specified by:

isSetX in interface Point3D

Returns:

whether x is set

isSetY

public boolean isSetY()

Specified by:

isSetY in interface Point3D

Returns:

whether y is set

isSetZ

public boolean isSetZ()

Specified by:

isSetZ in interface Point3D

Returns:

whether z is set

setFontFamily

public void setFontFamily(java.lang.String fontFamily)

Description copied from interface: FontRenderStyle

Set the value of fontFamily

Specified by:

setFontFamily in interface FontRenderStyle

setFontFamily

public void setFontFamily(FontFamily fontFamily)

Description copied from interface: FontRenderStyle

Set the value of fontFamily by using a FontFamily type.

Specified by:

setFontFamily in interface FontRenderStyle

setFontSize

public void setFontSize(RelAbsVector fontSize)

Description copied from interface: FontRenderStyle

Set the value of fontSize

Specified by:

setFontSize in interface FontRenderStyle

setFontStyleItalic

public void setFontStyleItalic(boolean fontStyleItalic)

Description copied from interface: FontRenderStyle

Set the value of fontStyleItalic

Specified by:

setFontStyleItalic in interface FontRenderStyle

setFontWeightBold

public void setFontWeightBold(boolean fontWeightBold)

Description copied from interface: FontRenderStyle

Set the value of fontWeightBold

Specified by:

setFontWeightBold in interface FontRenderStyle

setText

public void setText(java.lang.String text)

Set the value of the text field (and fire appropriate property-change event)

Parameters:

text - the new text

setTextAnchor

public void setTextAnchor(HTextAnchor textAnchor)

Description copied from interface: FontRenderStyle

Set the value of textAnchor

Specified by:

setTextAnchor in interface FontRenderStyle

setVTextAnchor

public void setVTextAnchor(VTextAnchor vTextAnchor)

Description copied from interface: FontRenderStyle

Set the value of VTextAnchor

Specified by:

setVTextAnchor in interface FontRenderStyle

setX

public void setX(RelAbsVector x)

Description copied from interface: Point3D

Set the value of x

Specified by:

setX in interface Point3D

setY

public void setY(RelAbsVector y)

Description copied from interface: Point3D

Set the value of y

Specified by:

setY in interface Point3D

setZ

public void setZ(RelAbsVector z)

Description copied from interface: Point3D

Set the value of z

Specified by:

setZ in interface Point3D

unsetFontFamily

public boolean unsetFontFamily()

Description copied from interface: FontRenderStyle

Unsets the variable fontFamily

Specified by:

unsetFontFamily in interface FontRenderStyle

Returns:

true, if fontFamily was set before, otherwise false

unsetFontSize

public boolean unsetFontSize()

Description copied from interface: FontRenderStyle

Unsets the variable fontSize

Specified by:

unsetFontSize in interface FontRenderStyle

Returns:

true, if fontSize was set before, otherwise false

unsetFontStyleItalic

public boolean unsetFontStyleItalic()

Description copied from interface: FontRenderStyle

Unsets the variable fontStyleItalic

Specified by:

unsetFontStyleItalic in interface FontRenderStyle

Returns:

true, if fontStyleItalic was set before, otherwise false

unsetFontWeightBold

public boolean unsetFontWeightBold()

Description copied from interface: FontRenderStyle

Unsets the variable fontWeightBold

Specified by:

unsetFontWeightBold in interface FontRenderStyle

Returns:

true, if fontWeightBold was set before, otherwise false

unsetText

public boolean unsetText()

Unsets the text and fires appropriate change event

Returns:

whether the text could be unset

unsetTextAnchor

public boolean unsetTextAnchor()

Description copied from interface: FontRenderStyle

Unsets the variable textAnchor

Specified by:

unsetTextAnchor in interface FontRenderStyle

Returns:

true, if textAnchor was set before, otherwise false

unsetVTextAnchor

public boolean unsetVTextAnchor()

Description copied from interface: FontRenderStyle

Unsets the variable VTextAnchor

Specified by:

unsetVTextAnchor in interface FontRenderStyle

Returns:

true, if VTextAnchor was set before, otherwise false

unsetX

public boolean unsetX()

Description copied from interface: Point3D

Unsets the variable x

Specified by:

unsetX in interface Point3D

Returns:

true, if x was set before, otherwise false

unsetY

public boolean unsetY()

Description copied from interface: Point3D

Unsets the variable y

Specified by:

unsetY in interface Point3D

Returns:

true, if y was set before, otherwise false

unsetZ

public boolean unsetZ()

Description copied from interface: Point3D

Unsets the variable z

Specified by:

unsetZ in interface Point3D

Returns:

true, if z was set before, otherwise false

writeXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Overrides:

writeXMLAttributes in class GraphicalPrimitive1D

readAttribute

public boolean readAttribute(java.lang.String attributeName,
                             java.lang.String prefix,
                             java.lang.String value)

Overrides:

readAttribute in class GraphicalPrimitive1D

hashCode

public int hashCode()

Overrides:

hashCode in class GraphicalPrimitive1D

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class GraphicalPrimitive1D

toString

public java.lang.String toString()

Overrides:

toString in class org.sbml.jsbml.AbstractSBase

Returns:

An informative string about this Text-object. Contains the text (which is not an XML-attribute)