Package org.sbml.jsbml.ext.render

Class Style

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.render.Style

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, org.sbml.jsbml.NamedSBase, org.sbml.jsbml.SBase, org.sbml.jsbml.UniqueNamedSBase, org.sbml.jsbml.UniqueSId, org.sbml.jsbml.util.TreeNodeWithChangeSupport

Direct Known Subclasses:

LocalStyle

public class Style
extends org.sbml.jsbml.AbstractNamedSBase
implements org.sbml.jsbml.UniqueNamedSBase

Since:

1.0

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Style.Type	The type StyleType is used by LocalStyle and GlobalStyle elements, in order to apply a particular style to a GraphicalObject.

Field Summary

Fields

Modifier and Type	Field	Description
protected RenderGroup	group
protected java.util.List<java.lang.String>	roleList
protected java.util.List<Style.Type>	typeList

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Style	clone()
boolean	equals(java.lang.Object obj)
boolean	getAllowsChildren()
javax.swing.tree.TreeNode	getChildAt(int index)
int	getChildCount()
RenderGroup	getGroup()
java.util.List<java.lang.String>	getRoleList()
java.util.List<Style.Type>	getTypeList()
int	hashCode()
void	initDefaults()	Initializes the default values using the namespace.
boolean	isIdMandatory()
boolean	isSetGroup()
boolean	isSetRoleList()
boolean	isSetTypeList()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
void	setGroup(RenderGroup group)	Set the value of group
boolean	setRoleList(java.util.List<java.lang.String> roleList)	Set the value of roleList
boolean	setTypeList(java.util.List<Style.Type> typeList)	Set the value of typeList
boolean	unsetGroup()	Unsets the variable group
boolean	unsetRoleList()	Unsets the variable roleList
boolean	unsetTypeList()	Unsets the variable typeList
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

isValidId

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, getAnnotation, getAnnotationString, 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, 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, toString, 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 interface org.sbml.jsbml.NamedSBase

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sbml.jsbml.SBase

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, getParent, isLeaf

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

Field Detail

group

protected RenderGroup group

roleList

protected java.util.List<java.lang.String> roleList

typeList

protected java.util.List<Style.Type> typeList

Constructor Detail

Style

public Style()

Creates a Style instance with a group

Style

public Style(RenderGroup group)

Creates a Style instance with a group

Parameters:

group -

Style

public Style(int level,
             int version,
             RenderGroup group)

Creates a Style instance with a level and version.

Parameters:

level -

version -

group -

Style

public Style(java.lang.String id,
             int level,
             int version,
             RenderGroup group)

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

Parameters:

id -

level -

version -

group -

Style

public Style(Style obj)

Clone constructor

Parameters:

obj - the Style instance to be cloned

Method Detail

clone

public Style clone()

Specified by:

clone in interface org.sbml.jsbml.SBase

Specified by:

clone in class org.sbml.jsbml.AbstractSBase

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

Overrides:

getAllowsChildren in class org.sbml.jsbml.AbstractSBase

getChildAt

public javax.swing.tree.TreeNode getChildAt(int index)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class org.sbml.jsbml.AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class org.sbml.jsbml.AbstractSBase

getGroup

public RenderGroup getGroup()

Returns:

the value of group

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

isIdMandatory

public boolean isIdMandatory()

Specified by:

isIdMandatory in interface org.sbml.jsbml.NamedSBase

Specified by:

isIdMandatory in interface org.sbml.jsbml.SBase

Overrides:

isIdMandatory in class org.sbml.jsbml.AbstractSBase

isSetGroup

public boolean isSetGroup()

Returns:

whether group is set

setGroup

public void setGroup(RenderGroup group)

Set the value of group

Parameters:

group -

hashCode

public int hashCode()

Specified by:

hashCode in interface org.sbml.jsbml.SBase

Overrides:

hashCode in class org.sbml.jsbml.AbstractSBase

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface org.sbml.jsbml.SBase

Overrides:

equals in class org.sbml.jsbml.AbstractSBase

unsetGroup

public boolean unsetGroup()

Unsets the variable group

Returns:

true, if group was set before, otherwise false

getRoleList

public java.util.List<java.lang.String> getRoleList()

Returns:

the value of roleList

isSetRoleList

public boolean isSetRoleList()

Returns:

whether roleList is set

setRoleList

public boolean setRoleList(java.util.List<java.lang.String> roleList)

Set the value of roleList

Parameters:

roleList -

getTypeList

public java.util.List<Style.Type> getTypeList()

Returns:

the value of typeList

isSetTypeList

public boolean isSetTypeList()

Returns:

whether typeList is set

setTypeList

public boolean setTypeList(java.util.List<Style.Type> typeList)

Set the value of typeList

Parameters:

typeList -

unsetTypeList

public boolean unsetTypeList()

Unsets the variable typeList

Returns:

true, if typeList was set before, otherwise false

unsetRoleList

public boolean unsetRoleList()

Unsets the variable roleList

Returns:

true, if roleList was set before, otherwise false

writeXMLAttributes

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

Specified by:

writeXMLAttributes in interface org.sbml.jsbml.SBase

Overrides:

writeXMLAttributes in class org.sbml.jsbml.AbstractSBase

readAttribute

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

Specified by:

readAttribute in interface org.sbml.jsbml.SBase

Overrides:

readAttribute in class org.sbml.jsbml.AbstractSBase