org.sbml.jsbml.ext.render

Class LocalRenderInformation

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.render.RenderInformationBase

org.sbml.jsbml.ext.render.LocalRenderInformation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, NamedSBase, SBase, UniqueNamedSBase, TreeNodeWithChangeSupport

public class LocalRenderInformation
extends RenderInformationBase

Since:

1.0

Version:

$Rev: 1722 $

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private ListOf<LocalStyle>	listOfLocalStyles
private static long	serialVersionUID Generated serial version identifier

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

backgroundColor, listOfColorDefinitions, listOfGradientDefintions, listOfLineEndings, programName, programVersion, referenceRenderInformation

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
LocalRenderInformation() Creates an LocalRenderInformation instance
LocalRenderInformation(int level, int version) Creates a LocalRenderInformation instance with a level and version.
LocalRenderInformation(LocalRenderInformation obj) Clone constructor
LocalRenderInformation(java.lang.String id) Creates a LocalRenderInformation instance with an id.
LocalRenderInformation(java.lang.String id, int level, int version) Creates a LocalRenderInformation instance with an id, level, and version.
LocalRenderInformation(java.lang.String id, java.lang.String name, int level, int version) Creates a LocalRenderInformation instance with an id, name, level, and version.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addLocalStyle(LocalStyle localStyle)
LocalRenderInformation	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
boolean	equals(java.lang.Object obj) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
SBase	getChildAt(int childIndex)
int	getChildCount()
ListOf<LocalStyle>	getListOfLocalStyles()
int	hashCode() Returns a hash code value for this SBase instance.
void	initDefaults() Initializes the default values using the namespace.
boolean	isSetListOfLocalStyles()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	removeLocalStyle(int i)
boolean	removeLocalStyle(LocalStyle localStyle)
void	setListOfLocalStyles(ListOf<LocalStyle> listOfLocalStyles)
boolean	unsetListOfLocalStyles()

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

addColorDefinition, addGradientBase, addLineEnding, getAllowsChildren, getBackgroundColor, getListOfColorDefinitions, getListOfGradientDefintions, getListOfLineEndings, getProgramName, getProgramVersion, getReferenceRenderInformation, isIdMandatory, isSetBackgroundColor, isSetListOfColorDefinitions, isSetListOfGradientDefintions, isSetListOfLineEndings, isSetProgramName, isSetProgramVersion, isSetReferenceRenderInformation, removeColorDefinition, removeColorDefinition, removeColorDefinition, removeGradientBase, removeGradientBase, removeLineEnding, removeLineEnding, setBackgroundColor, setListOfColorDefinitions, setListOfGradientDefintions, setListOfLineEndings, setProgramName, setProgramVersion, setReferenceRenderInformation, unsetBackgroundColor, unsetListOfColorDefinitions, unsetListOfGradientDefintions, unsetListOfLineEndings, unsetProgramName, unsetProgramVersion, unsetReferenceRenderInformation, writeXMLAttributes

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

getId, getName, isSetId, isSetName, isValidId, setId, setName, toString, unsetId, unsetName

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, 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, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sbml.jsbml.NamedSBase

getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm

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

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier

See Also:

Constant Field Values

listOfLocalStyles

private ListOf<LocalStyle> listOfLocalStyles

Constructor Detail

LocalRenderInformation

public LocalRenderInformation()

Creates an LocalRenderInformation instance

LocalRenderInformation

public LocalRenderInformation(java.lang.String id)

Creates a LocalRenderInformation instance with an id.

Parameters:

id -

LocalRenderInformation

public LocalRenderInformation(int level,
                      int version)

Creates a LocalRenderInformation instance with a level and version.

Parameters:

level -

version -

LocalRenderInformation

public LocalRenderInformation(java.lang.String id,
                      int level,
                      int version)

Creates a LocalRenderInformation instance with an id, level, and version.

Parameters:

id -

level -

version -

LocalRenderInformation

public LocalRenderInformation(java.lang.String id,
                      java.lang.String name,
                      int level,
                      int version)

Creates a LocalRenderInformation instance with an id, name, level, and version.

Parameters:

id -

name -

level -

version -

LocalRenderInformation

public LocalRenderInformation(LocalRenderInformation obj)

Clone constructor

Method Detail

clone

public LocalRenderInformation clone()

Description copied from interface: SBase

Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.

Specified by:

clone in interface SBase

Overrides:

clone in class RenderInformationBase

Returns:

a copy of this object

initDefaults

public void initDefaults()

Description copied from class: RenderInformationBase

Initializes the default values using the namespace.

Overrides:

initDefaults in class RenderInformationBase

hashCode

public int hashCode()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class RenderInformationBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: SBase

Returns true if and only if the given SBase has exactly the same properties like this SBase instance.

Specified by:

equals in interface SBase

Overrides:

equals in class RenderInformationBase

Parameters:

obj - the SBase to be compared to.

Returns:

true if and only if the given Object is an instance of SBase that has exactly the same properties like this SBase instance.

isSetListOfLocalStyles

public boolean isSetListOfLocalStyles()

Returns:

true, if listOfLocalStyles contains at least one element, otherwise false

getListOfLocalStyles

public ListOf<LocalStyle> getListOfLocalStyles()

Returns:

the listOfLocalStyles

setListOfLocalStyles

public void setListOfLocalStyles(ListOf<LocalStyle> listOfLocalStyles)

Parameters:

listOfLocalStyles -

unsetListOfLocalStyles

public boolean unsetListOfLocalStyles()

Returns:

true, if listOfLocalStyles contained at least one element, otherwise false

addLocalStyle

public boolean addLocalStyle(LocalStyle localStyle)

Parameters:

localStyle -

removeLocalStyle

public boolean removeLocalStyle(LocalStyle localStyle)

Parameters:

localStyle -

removeLocalStyle

public void removeLocalStyle(int i)

Parameters:

index -

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class RenderInformationBase

getChildAt

public SBase getChildAt(int childIndex)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class RenderInformationBase

readAttribute

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

Description copied from interface: SBase

Sets the given attribute in this SBase.

If the given attribute name is not recognized, nothing is done and false is returned.

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class RenderInformationBase

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.