Style (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.Style

Direct Known Subclasses:

GlobalStyle, LocalStyle
```
public class Style
extends SBase
```
render Abstract base class for local and global styles.
Local and global styles in the SBML Level 3 Render package have many attributes and methods in common. These have been implemented in the abstract base class Style.
A style is a graphical representation for certain layout objects. The assignment of styles to individual layout objects can either be done through layout object ids (local styles only), layout object types (SPECIES, COMPARTMENT, etc.) or layout object roles.

Constructor Summary

Constructors
Constructor and Description

Style(Style orig)
Copy constructor for Style.

Constructors
Constructor and Description
`Style(Style orig)` Copy constructor for `Style`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addRole(java.lang.String role)` Adds an id to the role list.
`int`	`addType(java.lang.String type)` Adds a type string to the type list.
`SBase`	`cloneObject()` Creates and returns a deep copy of this `Style` object.
`RenderGroup`	`createGroup()` Creates a new `RenderGroup` object, adds it to this `Style` object and returns the `RenderGroup` object created.
`java.lang.String`	`createRoleString()`
`java.lang.String`	`createTypeString()`
`void`	`delete()` Explicitly deletes the underlying native object.
`SBase`	`getElementByMetaId(java.lang.String metaid)` Returns the first child element that has the given `metaid`, or `null` if no such object is found.
`SBase`	`getElementBySId(java.lang.String id)` Returns the first child element that has the given `id` in the model-wide SId namespace, or `null` if no such object is found.
`java.lang.String`	`getElementName()` Returns the XML element name of this `Style` object.
`RenderGroup`	`getGroup()` Returns the value of the 'group' element of this `Style`.
`java.lang.String`	`getId()` Returns the value of the 'id' attribute of this `Style`.
`java.lang.String`	`getName()` Returns the value of the 'name' attribute of this `Style`.
`long`	`getNumRoles()` Returns the number of ids in the role list.
`long`	`getNumTypes()` Returns the number of types in the type list.
`StringSet`	`getRoleList()` Returns the value of the 'roleList' attribute of this `Style`.
`int`	`getTypeCode()` Returns the libSBML type code for this `Style` object.
`StringSet`	`getTypeList()` Returns the type list.
`boolean`	`hasRequiredAttributes()` Predicate returning `true` if all the required attributes for this `Style` object have been set.
`boolean`	`isGlobalStyle()` Predicate returning `true` if this abstract `Style` is of type `GlobalStyle`
`boolean`	`isInRoleList(java.lang.String role)` Checks whether a given role is in the role list.
`boolean`	`isInTypeList(java.lang.String type)` Checks whether a given type string is in the type list.
`boolean`	`isLocalStyle()` Predicate returning `true` if this abstract `Style` is of type `LocalStyle`
`boolean`	`isSetGroup()` Predicate returning `true` if this `Style`'s 'group' element is set.
`boolean`	`isSetId()` Predicate returning `true` if this `Style`'s 'id' attribute is set.
`boolean`	`isSetName()` Predicate returning `true` if this `Style`'s 'name' attribute is set.
`int`	`removeRole(java.lang.String role)` Removes the given role from the role list.
`int`	`removeType(java.lang.String type)` Removes a type string from the type list.
`int`	`setGroup(RenderGroup group)` Sets the value of the 'group' element of this `Style`.
`int`	`setId(java.lang.String id)` Sets the value of the 'id' attribute of this `Style`.
`int`	`setName(java.lang.String name)` Sets the value of the 'name' attribute of this `Style`.
`int`	`setRoleList(StringSet roleList)` Sets the complete role list to a copy of the given list.
`int`	`setTypeList(StringSet typeList)` Sets the complete type list to a copy of the given list.
`XMLNode`	`toXML()` Creates an `XMLNode` object from this `Style` object.
`int`	`unsetGroup()` Unsets the value of the 'group' element of this `Style`.
`int`	`unsetId()` Unsets the value of the 'id' attribute of this `Style`.
`int`	`unsetName()` Unsets the value of the 'name' attribute of this `Style`.

Methods inherited from class org.sbml.libsbml.SBase
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageCoreVersion, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setIdAttribute, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm, unsetUserData

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Style
```
public Style(Style orig)
```
    Copy constructor for Style.
    
    Parameters:
    
    orig - the Style instance to copy.
- Method Detail
  - delete
```
public void delete()
```
    Explicitly deletes the underlying native object.
    In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize() methods for the objects. The finalize() methods in turn call the Style.delete() method on the libSBML object.
    This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke Style.delete() themselves.
    
    Overrides:
    
    delete in class SBase
  - cloneObject
```
public SBase cloneObject()
```
    Creates and returns a deep copy of this Style object.
    
    Overrides:
    
    cloneObject in class SBase
    
    Returns:
    
    a (deep) copy of this Style object.
  - getId
```
public java.lang.String getId()
```
    Returns the value of the 'id' attribute of this Style.
    
    Overrides:
    
    getId in class SBase
    
    Returns:
    
    the value of the 'id' attribute of this Style as a string.
    
    See Also:
    
    SBase.getIdAttribute(), SBase.setIdAttribute(String sid), SBase.isSetIdAttribute(), SBase.unsetIdAttribute()
  - getName
```
public java.lang.String getName()
```
    Returns the value of the 'name' attribute of this Style.
    
    Overrides:
    
    getName in class SBase
    
    Returns:
    
    the value of the 'name' attribute of this Style as a string.
    
    See Also:
    
    SBase.getIdAttribute(), SBase.isSetName(), SBase.setName(String sid), SBase.unsetName()
  - isSetId
```
public boolean isSetId()
```
    Predicate returning true if this Style's 'id' attribute is set.
    
    Overrides:
    
    isSetId in class SBase
    
    Returns:
    
    true if this Style's 'id' attribute has been set, otherwise false is returned.
    
    See Also:
    
    SBase.getIdAttribute(), SBase.setIdAttribute(String sid), SBase.unsetIdAttribute(), SBase.isSetIdAttribute()
  - isSetName
```
public boolean isSetName()
```
    Predicate returning true if this Style's 'name' attribute is set.
    
    Overrides:
    
    isSetName in class SBase
    
    Returns:
    
    true if this Style's 'name' attribute has been set, otherwise false is returned.
    
    See Also:
    
    SBase.getName(), SBase.setName(String sid), SBase.unsetName()
  - setId
```
public int setId(java.lang.String id)
```
    Sets the value of the 'id' attribute of this Style.
    Overrides:
    
    setId in class SBase
    
    Parameters:
    
    id - String& value of the 'id' attribute to be set.
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
    
    Calling this function with id = null or an empty string is equivalent to calling unsetId().
    See Also:
    
    SBase.getIdAttribute(), SBase.setIdAttribute(String sid), SBase.isSetIdAttribute(), SBase.unsetIdAttribute()
  - setName
```
public int setName(java.lang.String name)
```
    Sets the value of the 'name' attribute of this Style.
    Overrides:
    
    setName in class SBase
    
    Parameters:
    
    name - String& value of the 'name' attribute to be set.
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
    
    Calling this function with name = null or an empty string is equivalent to calling unsetName().
  - unsetId
```
public int unsetId()
```
    Unsets the value of the 'id' attribute of this Style.
    Overrides:
    
    unsetId in class SBase
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
    See Also:
    
    SBase.getIdAttribute(), SBase.setIdAttribute(String sid), SBase.isSetIdAttribute(), SBase.unsetIdAttribute()
  - unsetName
```
public int unsetName()
```
    Unsets the value of the 'name' attribute of this Style.
    Overrides:
    
    unsetName in class SBase
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
    See Also:
    
    SBase.getName(), SBase.setName(String sid), SBase.isSetName()
  - getRoleList
```
public StringSet getRoleList()
```
    Returns the value of the 'roleList' attribute of this Style.
    
    Returns:
    
    the value of the 'roleList' attribute of this Style as a string.
  - getNumRoles
```
public long getNumRoles()
```
    Returns the number of ids in the role list.
    
    Returns:
    
    the number of roles in the role list.
  - isInRoleList
```
public boolean isInRoleList(java.lang.String role)
```
    Checks whether a given role is in the role list.
    
    Parameters:
    
    role - role string to check for in the role list.
  - addRole
```
public int addRole(java.lang.String role)
```
    Adds an id to the role list.
    
    Parameters:
    
    role - New role to be added to the role list.
  - createRoleString
```
public java.lang.String createRoleString()
```
    Returns:
    
    the string of all roles
  - removeRole
```
public int removeRole(java.lang.String role)
```
    Removes the given role from the role list.
    
    Parameters:
    
    role - role string to be removed from the role list.
  - setRoleList
```
public int setRoleList(StringSet roleList)
```
    Sets the complete role list to a copy of the given list.
    
    Parameters:
    
    roleList - New list of role strings to be set on the style.
  - getTypeList
```
public StringSet getTypeList()
```
    Returns the type list.
    Returns:
    reference to the type list.
    
    The attribute 'typeList' for LocalStyle and GlobalStyle objects contains a list of StyleType entries that describe what sorts of object to apply the style to. In the SBML Level 3 Version 1 Render specification, the following are the allowable entries in a whitespace-separated 'typeList':
    
    'COMPARTMENTGLYPH': The style is to be applied to all compartment glyphs.
    
    'SPECIESGLYPH': The style is to be applied to all species glyphs.
    
    'REACTIONGLYPH': The style is to be applied to all reaction glyphs.
    
    'SPECIESREFERENCEGLYPH': The style is to be applied to all species reference glyphs.
    
    'TEXTGLYPH': The style is to be applied to all text glyphs.
    
    'GENERALGLYPH': The style is to be applied to all general glyphs.
    
    'GRAPHICALOBJECT': The style is to be applied to all graphical objects.
    
    'ANY': The style is to be applied to any and all glyphs and graphical objects. Equivalent to explicitly listing all other keywords.
  - getNumTypes
```
public long getNumTypes()
```
    Returns the number of types in the type list.
    
    Returns:
    
    number of types in type list.
  - isInTypeList
```
public boolean isInTypeList(java.lang.String type)
```
    Checks whether a given type string is in the type list.
    Parameters:
    
    type - string to be searched for in the type list
    
    Returns:
    true or false depending on whether the given string was found in the type list.
    
    The attribute 'typeList' for LocalStyle and GlobalStyle objects contains a list of StyleType entries that describe what sorts of object to apply the style to. In the SBML Level 3 Version 1 Render specification, the following are the allowable entries in a whitespace-separated 'typeList':
    
    'COMPARTMENTGLYPH': The style is to be applied to all compartment glyphs.
    
    'SPECIESGLYPH': The style is to be applied to all species glyphs.
    
    'REACTIONGLYPH': The style is to be applied to all reaction glyphs.
    
    'SPECIESREFERENCEGLYPH': The style is to be applied to all species reference glyphs.
    
    'TEXTGLYPH': The style is to be applied to all text glyphs.
    
    'GENERALGLYPH': The style is to be applied to all general glyphs.
    
    'GRAPHICALOBJECT': The style is to be applied to all graphical objects.
    
    'ANY': The style is to be applied to any and all glyphs and graphical objects. Equivalent to explicitly listing all other keywords.
  - addType
```
public int addType(java.lang.String type)
```
    Adds a type string to the type list.
    
    Parameters:
    
    type - new type string to be added to the type list
  - createTypeString
```
public java.lang.String createTypeString()
```
    Returns:
    
    the string of all types
  - removeType
```
public int removeType(java.lang.String type)
```
    Removes a type string from the type list.
    
    Parameters:
    
    type - type string to be removed from the type list.
  - setTypeList
```
public int setTypeList(StringSet typeList)
```
    Sets the complete type list to a copy of the given list.
    Parameters:
    typeList - the list of types to be set for the style.
    
    The attribute 'typeList' for LocalStyle and GlobalStyle objects contains a list of StyleType entries that describe what sorts of object to apply the style to. In the SBML Level 3 Version 1 Render specification, the following are the allowable entries in a whitespace-separated 'typeList':
    
    'COMPARTMENTGLYPH': The style is to be applied to all compartment glyphs.
    
    'SPECIESGLYPH': The style is to be applied to all species glyphs.
    
    'REACTIONGLYPH': The style is to be applied to all reaction glyphs.
    
    'SPECIESREFERENCEGLYPH': The style is to be applied to all species reference glyphs.
    
    'TEXTGLYPH': The style is to be applied to all text glyphs.
    
    'GENERALGLYPH': The style is to be applied to all general glyphs.
    
    'GRAPHICALOBJECT': The style is to be applied to all graphical objects.
    
    'ANY': The style is to be applied to any and all glyphs and graphical objects. Equivalent to explicitly listing all other keywords.
  - getGroup
```
public RenderGroup getGroup()
```
    Returns the value of the 'group' element of this Style.
    
    Returns:
    
    the value of the 'group' element of this Style as a RenderGroup.
  - isSetGroup
```
public boolean isSetGroup()
```
    Predicate returning true if this Style's 'group' element is set.
    
    Returns:
    
    true if this Style's 'group' element has been set, otherwise false is returned.
  - setGroup
```
public int setGroup(RenderGroup group)
```
    Sets the value of the 'group' element of this Style.
    Parameters:
    
    group - RenderGroup value of the 'group' element to be set.
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - createGroup
```
public RenderGroup createGroup()
```
    Creates a new RenderGroup object, adds it to this Style object and returns the RenderGroup object created.
    
    Returns:
    
    a new RenderGroup object instance.
  - unsetGroup
```
public int unsetGroup()
```
    Unsets the value of the 'group' element of this Style.
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - isGlobalStyle
```
public boolean isGlobalStyle()
```
    Predicate returning true if this abstract Style is of type GlobalStyle
    
    Returns:
    
    true if this abstract Style is of type GlobalStyle, false otherwise
  - isLocalStyle
```
public boolean isLocalStyle()
```
    Predicate returning true if this abstract Style is of type LocalStyle
    
    Returns:
    
    true if this abstract Style is of type LocalStyle, false otherwise
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this Style object.
    For Style, the XML element name is always 'style'.
    
    Overrides:
    
    getElementName in class SBase
    
    Returns:
    
    the name of this element, i.e. 'style'.
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code for this Style object.
    
    LibSBML attaches an identifying code to every kind of SBML object. These are integer constants known as SBML type codes. The names of all the codes begin with the characters SBML_. In the Java language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbmlConstants. Note that different Level 3 package plug-ins may use overlapping type codes; to identify the package to which a given object belongs, call the SBase.getPackageName() method on the object.
    The exception to this is lists: all SBML-style list elements have the type SBML_LIST_OF, regardless of what package they are from.
    
    Overrides:
    
    getTypeCode in class SBase
    
    Returns:
    
    the SBML type code for this object: SBML_RENDER_STYLE_BASE.
    
    See Also:
    
    Style.getElementName(), SBase.getPackageName()
    
    Warning:
    
    The specific integer values of the possible type codes may be reused by different libSBML plug-ins for SBML Level 3. packages, To fully identify the correct code, it is necessary to invoke both getPackageName() and getTypeCode() (or ListOf.getItemTypeCode()).
  - hasRequiredAttributes
```
public boolean hasRequiredAttributes()
```
    Predicate returning true if all the required attributes for this Style object have been set.
    
    Overrides:
    
    hasRequiredAttributes in class SBase
    
    Returns:
    
    true to indicate that all the required attributes of this Style have been set, otherwise false is returned.
  - getElementBySId
```
public SBase getElementBySId(java.lang.String id)
```
    Returns the first child element that has the given id in the model-wide SId namespace, or null if no such object is found.
    
    Overrides:
    
    getElementBySId in class SBase
    
    Parameters:
    
    id - a string representing the id attribute of the object to retrieve.
    
    Returns:
    
    a pointer to the SBase element with the given id. If no such object is found, this method returns null.
  - getElementByMetaId
```
public SBase getElementByMetaId(java.lang.String metaid)
```
    Returns the first child element that has the given metaid, or null if no such object is found.
    
    Overrides:
    
    getElementByMetaId in class SBase
    
    Parameters:
    
    metaid - a string representing the metaid attribute of the object to retrieve.
    
    Returns:
    
    a pointer to the SBase element with the given metaid. If no such object is found this method returns null.
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this Style object.
    
    Returns:
    
    the XMLNode with the XML representation for the Style object.

Class Style

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

Style

Method Detail

delete

cloneObject

getId

getName

isSetId

isSetName

setId

setName

unsetId

unsetName

getRoleList

getNumRoles

isInRoleList

addRole

createRoleString

removeRole

setRoleList

getTypeList

getNumTypes

isInTypeList

addType

createTypeString

removeType

setTypeList

getGroup

isSetGroup

setGroup

createGroup

unsetGroup

isGlobalStyle

isLocalStyle

getElementName

getTypeCode

hasRequiredAttributes

getElementBySId

getElementByMetaId

toXML