All Superinterfaces:: AbstractModelComponent, AbstractVisibleComponent, ReadOnlyInterface

All Known Subinterfaces:: Compartment

public interface Compartment
extends AbstractVisibleComponent

Method Summary

Modifier and Type	Method	Description
`double`	`blur()`	The item's blur.
`Font`	`font()`	The item's text label font.
`Object`	`getCustomProperty(String name)`	Returns the value of the custom property or `null` if not available.
`List<? extends CompartmentItem>`	`getDiagramItems()`
`List<? extends CompartmentItem>`	`getDiagramItems(Diagram diagram)`
`String`	`getIdentifier()`
`Metabolite`	`getMetabolite(String name)`	Returns the metabolite node of the given name if available in the compartment, otherwise null.
`Set<? extends PublicIdentifier>`	`getPublicIdentifiers()`	Returns the components public identifiers
`Compartment`	`getSubCompartment(String name)`	Returns a sub compartment of the given name if available in the compartment, otherwise null.
`boolean`	`hidden()`	Visibility of the network component.
`List<? extends Metabolite>`	`metabolites()`	Returns an unchangeable `List` of all metabolites that occur in this compartment.
`FormattedName`	`name()`	Returns the item's name label as formatted text (html).
`Compartment`	`outside()`	Returns the outside compartment if available otherwise null.
`Paint`	`paint()`	The fill brush of the item's shape.
`void`	`setCustomProperty(String name, Object value)`	Adds a custom property to the network item.
`void`	`setTmpCustomProperty(String name, Object value)`	Adds a temporary custom property to the network item.
`Shape`	`shape()`	The fill brush of the item's shape.
`Color`	`strokeColor()`	The color for the stroke of the item's shape.
`StrokeStyle`	`strokeStyle()`	The paint style for the stroke of the item's shape.
`double`	`strokeWidth()`	The stroke width of the item's shape.
`List<? extends Compartment>`	`subCompartments()`	Returns an unchangeable `List` of all sub compartments.
`Synonyms`	`synonyms()`	Returns the synonyms of the item.
`double`	`textBlur()`	The blur of the item's text.
`Brush`	`textBrush()`	The fill brush of the item's text label.
`Shadow`	`textShadow()`	The shadow of the item's text.
`Color`	`textStrokeColor()`	The color for the stroke of the item's text label.
`double`	`textStrokeWidth()`	The stroke width of the item's text label.
`double`	`textTransparency()`	The transparency of the item's text.
`double`	`transparency()`	The item's transparency.

Methods inherited from interface omix.plugin.model.AbstractModelComponent

addChangeListener, addPropertyChangeListener, fieldExists, getField, getField, model, removeChangeListener, removePropertyChangeListener

Methods inherited from interface omix.plugin.model.AbstractVisibleComponent

accessoryExists, getAccessories, getAccessories, getAccessory, getAccessory, getAccessory, getAccessory, getAllAccessories, hasDiagramItems, hasDiagramItems

Method Details
- name
  
  FormattedName name()
  
  Returns the item's name label as formatted text (html).
  
  Returns:
  
  name as formatted text
  
  Since:
  
  Omix 1.9.0
- subCompartments
  
  List<? extends Compartment> subCompartments()
  
  Returns an unchangeable List of all sub compartments.
  
  Returns:
  
  sub compartments
- outside
  
  Compartment outside()
  
  Returns the outside compartment if available otherwise null.
  
  Returns:
  
  outside compartment
- metabolites
  
  List<? extends Metabolite> metabolites()
  
  Returns an unchangeable List of all metabolites that occur in this compartment.
  
  Returns:
  
  all metabolites
- getMetabolite
  
  Metabolite getMetabolite(String name)
  
  Returns the metabolite node of the given name if available in the compartment, otherwise null.
  
  Parameters:
  
  name - of metabolite node
  
  Returns:
  
  found metabolite node
- getSubCompartment
  
  Compartment getSubCompartment(String name)
  
  Returns a sub compartment of the given name if available in the compartment, otherwise null.
  
  Parameters:
  
  name - of sub compartment
  
  Returns:
  
  found sub compartment
- getDiagramItems
  
  List<? extends CompartmentItem> getDiagramItems()
  
  Specified by:
  
  getDiagramItems in interface AbstractVisibleComponent
- getDiagramItems
  
  List<? extends CompartmentItem> getDiagramItems(Diagram diagram)
  
  Specified by:
  
  getDiagramItems in interface AbstractVisibleComponent
- getIdentifier
  
  String getIdentifier()
  
  Specified by:
  
  getIdentifier in interface AbstractModelComponent
- synonyms
  
  Synonyms synonyms()
  
  Returns the synonyms of the item.
  
  Returns:
  
  synonyms
  
  Since:
  
  Omix 1.9.0
- getPublicIdentifiers
  
  Set<? extends PublicIdentifier> getPublicIdentifiers()
  
  Returns the components public identifiers
  
  Returns:
  
  set of public identifiers
  
  Since:
  
  Omix 1.9.0
- strokeColor
  
  Color strokeColor()
  
  The color for the stroke of the item's shape.
- textStrokeColor
  
  Color textStrokeColor()
  
  The color for the stroke of the item's text label.
- textBrush
  
  Brush textBrush()
  
  The fill brush of the item's text label.
  
  Since:
  
  Omix 1.8.0
- paint
  
  Paint paint()
  
  The fill brush of the item's shape.
  
  Since:
  
  Omix 1.8.0
- shape
  
  Shape shape()
  
  The fill brush of the item's shape.
  
  Since:
  
  Omix 1.9.10
- textShadow
  
  Shadow textShadow()
  
  The shadow of the item's text.
  
  Since:
  
  Omix 1.5.13
- textBlur
  
  double textBlur()
  
  The blur of the item's text.
  
  Since:
  
  Omix 1.5.13
- textTransparency
  
  double textTransparency()
  
  The transparency of the item's text.
  
  Since:
  
  Omix 1.5.13
- blur
  
  double blur()
  
  The item's blur.
  
  Since:
  
  Omix 1.5.13
- transparency
  
  double transparency()
  
  The item's transparency.
  
  Since:
  
  Omix 1.5.13
- strokeStyle
  
  StrokeStyle strokeStyle()
  
  The paint style for the stroke of the item's shape.
- strokeWidth
  
  double strokeWidth()
  
  The stroke width of the item's shape.
- textStrokeWidth
  
  double textStrokeWidth()
  
  The stroke width of the item's text label.
- font
  
  Font font()
  
  The item's text label font.
- hidden
  
  boolean hidden()
  
  Visibility of the network component.
  
  Returns:
  
  hidden
- setCustomProperty
  
  void setCustomProperty(String name, Object value) throws IllegalAccessException
  
  Adds a custom property to the network item. Each item can carry arbitrary values as custom property. The property content is stored to the document file as far as possible. If the value cannot be saved to file, the property is removed after relaunch. Custom properties can be accessed from all namespaces. Set null to remove property. Setting custom properties in OVL is undoable.
  
  Parameters:
  
  name -
  
  value -
  
  Throws:
  
  IllegalAccessException
  
  See Also:
  
  setTmpCustomProperty(String, Object), getCustomProperty(String), #customPropertyNames()
- setTmpCustomProperty
  
  void setTmpCustomProperty(String name, Object value) throws IllegalAccessException
  
  Adds a temporary custom property to the network item. Each item can carry arbitrary values as custom property. The property content is not stored to the document file. Instead, the property is removed after relaunch. Custom properties can be accessed from all namespaces. Set null to remove property. Setting custom properties in OVL is undoable.
  
  Parameters:
  
  name -
  
  value -
  
  Throws:
  
  IllegalAccessException
  
  See Also:
  
  setCustomProperty(String, Object), getCustomProperty(String), #customPropertyNames()
- getCustomProperty
  
  Object getCustomProperty(String name)
  
  Returns the value of the custom property or null if not available.
  
  Parameters:
  
  name -
  
  Returns:
  
  value

Interface Compartment

Method Summary

Methods inherited from interface omix.plugin.model.AbstractModelComponent

Methods inherited from interface omix.plugin.model.AbstractVisibleComponent

Method Details