All Superinterfaces:: AbstractItem, AbstractItem, AbstractModelItem, AbstractModelItem, CompartmentItem, Groupable, Groupable, ReadOnlyInterface, WritableInterface

public interface CompartmentItem
extends AbstractModelItem, CompartmentItem, Groupable

Method Summary

Modifier and Type	Method	Description
`List<? extends Comment>`	`comments()`
`Comment`	`getComment(String identifier)`
`List<? extends MetaboliteItem>`	`getMetabolites(String name)`
`Group`	`group()`
`List<? extends MetaboliteItem>`	`metabolites()`
`Compartment`	`modelComponent()`
`CompartmentItem`	`outside()`	Returns the outside compartment if available otherwise null.
`void`	`setAccessoryAnchorFloating(boolean accessoryAnchorFloating)`
`void`	`setAccessoryAnchorPlacement(AccessoryAnchorPlacement accessoryAnchorPlacement)`	Changes the placement of the item's accessory anchor.
`void`	`setAccessoryAnchorPosition(double accessoryAnchorX, double accessoryAnchorY)`	Changes the position of the item's accessory anchor.
`void`	`setAccessoryFloating(boolean accessoryFloating)`
`void`	`setAccessoryOrientation(Orientation accessoryOrientation)`	Changes the layout (horizontal / vertical) of the item's accessory anchor.
`void`	`setAccessorySpacing(double accessorySpacing)`	Changes the spacing of the item's accessory anchor.
`void`	`setHidden(boolean hidden)`
`void`	`setLabelPosition(double labelX, double labelY)`	Changes the position of the item's label.
`void`	`setLabelRotation(double labelRotation)`	Changes the rotation of the position of the item's label.
`void`	`setPosition(double x, double y)`	Set the position of the item.
`void`	`setSize(double width, double height)`	Changes the item's size.
`void`	`setZValue(double z)`	Change z layer of the item (defines the stacked position of the item in the diagram).
`List<? extends CompartmentItem>`	`subCompartments()`	Returns an unchangeable `List` of all sub compartments.
`CompartmentItem`	`toReadOnly()`

Methods inherited from interface omix.plugin.diagram.AbstractItem

addChangeListener, addPropertyChangeListener, getIdentifier, removeChangeListener, removePropertyChangeListener

Methods inherited from interface omix.plugin.diagram.writable.AbstractItem

diagram, isChangeable

Methods inherited from interface omix.plugin.diagram.AbstractModelItem

getAccessoryItem, getAccessoryItem

Methods inherited from interface omix.plugin.diagram.writable.AbstractModelItem

getAccessoryItem, getAccessoryItem, getAccessoryItems, getAccessoryItems, getAllAccessoryItems, getField, getField

Methods inherited from interface omix.plugin.diagram.CompartmentItem

accessoryAnchorFloating, accessoryAnchorPlacement, accessoryAnchorX, accessoryAnchorY, accessoryFloating, accessoryOrientation, accessorySpacing, commentExists, getCustomProperty, hasInvalidPosition, height, hidden, labelRotation, labelX, labelY, setCustomProperty, setTmpCustomProperty, width, x, y, zValue

Method Details
- modelComponent
  
  Compartment modelComponent()
  
  Specified by:
  
  modelComponent in interface AbstractModelItem
  
  Specified by:
  
  modelComponent in interface AbstractModelItem
  
  Specified by:
  
  modelComponent in interface CompartmentItem
- setPosition
  
  void setPosition(double x, double y) throws IllegalChangeException
  
  Set the position of the item.
  
  Parameters:
  
  x -
  
  y -
  
  Throws:
  
  IllegalChangeException
- setSize
  
  void setSize(double width, double height) throws IllegalChangeException
  
  Changes the item's size.
  
  Parameters:
  
  width -
  
  height -
  
  Throws:
  
  IllegalChangeException
- setLabelPosition
  
  void setLabelPosition(double labelX, double labelY) throws IllegalChangeException
  
  Changes the position of the item's label.
  
  Parameters:
  
  labelX -
  
  labelY -
  
  Throws:
  
  IllegalChangeException
- setLabelRotation
  
  void setLabelRotation(double labelRotation) throws IllegalChangeException
  
  Changes the rotation of the position of the item's label.
  
  Parameters:
  
  labelRotation - rotation in degrees
  
  Throws:
  
  IllegalChangeException
- setZValue
  
  void setZValue(double z) throws IllegalChangeException
  
  Change z layer of the item (defines the stacked position of the item in the diagram).
  
  Parameters:
  
  z -
  
  Throws:
  
  IllegalChangeException
- group
  
  Group group()
  
  Specified by:
  
  group in interface Groupable
  
  Specified by:
  
  group in interface Groupable
- subCompartments
  
  List<? extends CompartmentItem> subCompartments()
  
  Returns an unchangeable List of all sub compartments.
  
  Specified by:
  
  subCompartments in interface CompartmentItem
  
  Returns:
  
  sub compartments
- outside
  
  CompartmentItem outside()
  
  Returns the outside compartment if available otherwise null.
  
  Specified by:
  
  outside in interface CompartmentItem
  
  Returns:
  
  outside compartment
- comments
  
  List<? extends Comment> comments()
  
  Specified by:
  
  comments in interface CompartmentItem
- getComment
  
  Comment getComment(String identifier)
  
  Specified by:
  
  getComment in interface CompartmentItem
- metabolites
  
  List<? extends MetaboliteItem> metabolites()
  
  Specified by:
  
  metabolites in interface CompartmentItem
- getMetabolites
  
  List<? extends MetaboliteItem> getMetabolites(String name)
  
  Specified by:
  
  getMetabolites in interface CompartmentItem
- setAccessoryAnchorPosition
  
  void setAccessoryAnchorPosition(double accessoryAnchorX, double accessoryAnchorY) throws IllegalChangeException
  
  Changes the position of the item's accessory anchor.
  
  Parameters:
  
  accessoryAnchorX -
  
  accessoryAnchorY -
  
  Throws:
  
  IllegalChangeException
- setAccessorySpacing
  
  void setAccessorySpacing(double accessorySpacing) throws IllegalChangeException
  
  Changes the spacing of the item's accessory anchor.
  
  Parameters:
  
  accessorySpacing -
  
  Throws:
  
  IllegalChangeException
- setAccessoryOrientation
  
  void setAccessoryOrientation(Orientation accessoryOrientation) throws IllegalChangeException
  
  Changes the layout (horizontal / vertical) of the item's accessory anchor.
  
  Parameters:
  
  accessoryOrientation -
  
  Throws:
  
  IllegalChangeException
- setAccessoryAnchorFloating
  
  void setAccessoryAnchorFloating(boolean accessoryAnchorFloating) throws IllegalChangeException
  
  Parameters:
  
  accessoryAnchorFloating -
  
  Throws:
  
  IllegalChangeException
- setAccessoryFloating
  
  void setAccessoryFloating(boolean accessoryFloating) throws IllegalChangeException
  
  Parameters:
  
  accessoryFloating -
  
  Throws:
  
  IllegalChangeException
- setAccessoryAnchorPlacement
  
  void setAccessoryAnchorPlacement(AccessoryAnchorPlacement accessoryAnchorPlacement) throws IllegalChangeException
  
  Changes the placement of the item's accessory anchor.
  
  Parameters:
  
  accessoryAnchorPlacement -
  
  Throws:
  
  IllegalChangeException
- toReadOnly
  
  CompartmentItem toReadOnly()
  
  Specified by:
  
  toReadOnly in interface AbstractItem
  
  Specified by:
  
  toReadOnly in interface AbstractModelItem
  
  Specified by:
  
  toReadOnly in interface Groupable
  
  Specified by:
  
  toReadOnly in interface WritableInterface
- setHidden
  
  void setHidden(boolean hidden) throws IllegalChangeException
  
  Throws:
  
  IllegalChangeException