Module omix.api

Package omix.plugin.diagram

Interface CompartmentItem

All Superinterfaces:

AbstractItem, AbstractModelItem, Groupable, ReadOnlyInterface

All Known Subinterfaces:

CompartmentItem

public interface CompartmentItem
extends AbstractModelItem, Groupable

Method Summary

Modifier and Type	Method	Description
boolean	accessoryAnchorFloating()
AccessoryAnchorPlacement	accessoryAnchorPlacement()
double	accessoryAnchorX()
double	accessoryAnchorY()
boolean	accessoryFloating()
Orientation	accessoryOrientation()
double	accessorySpacing()
boolean	commentExists(String identifier)
List<? extends Comment>	comments()
Comment	getComment(String identifier)
Object	getCustomProperty(String name)	Returns the value of the custom property or null if not available.
List<? extends MetaboliteItem>	getMetabolites(String name)
boolean	hasInvalidPosition()
double	height()
boolean	hidden()
double	labelRotation()
double	labelX()
double	labelY()
List<? extends MetaboliteItem>	metabolites()
Compartment	modelComponent()
CompartmentItem	outside()	Returns the outside compartment if available otherwise null.
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.
List<? extends CompartmentItem>	subCompartments()	Returns an unchangeable List of all sub compartments.
double	width()
double	x()
double	y()
double	zValue()

Methods inherited from interface omix.plugin.diagram.AbstractItem

addChangeListener, addPropertyChangeListener, diagram, getIdentifier, removeChangeListener, removePropertyChangeListener

Methods inherited from interface omix.plugin.diagram.AbstractModelItem

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

Methods inherited from interface omix.plugin.diagram.Groupable

group

Method Details

modelComponent

Compartment modelComponent()

Specified by:

modelComponent in interface AbstractModelItem

zValue

double zValue()

x

double x()

y

double y()

width

double width()

height

double height()

accessoryAnchorX

double accessoryAnchorX()

accessoryAnchorY

double accessoryAnchorY()

accessorySpacing

double accessorySpacing()

accessoryAnchorPlacement

AccessoryAnchorPlacement accessoryAnchorPlacement()

accessoryOrientation

Orientation accessoryOrientation()

accessoryAnchorFloating

boolean accessoryAnchorFloating()

accessoryFloating

boolean accessoryFloating()

labelX

double labelX()

labelY

double labelY()

labelRotation

double labelRotation()

subCompartments

List<? extends CompartmentItem> subCompartments()

Returns an unchangeable List of all sub compartments.

Returns:

sub compartments

outside

CompartmentItem outside()

Returns the outside compartment if available otherwise null.

Returns:

outside compartment

comments

List<? extends Comment> comments()

commentExists

boolean commentExists(String identifier)

getComment

Comment getComment(String identifier)

metabolites

List<? extends MetaboliteItem> metabolites()

getMetabolites

List<? extends MetaboliteItem> getMetabolites(String name)

hasInvalidPosition

boolean hasInvalidPosition()

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

hidden

boolean hidden()