org.simbrain.plot.piechart

Class PieChartComponent

java.lang.Object

org.simbrain.workspace.WorkspaceComponent

org.simbrain.plot.piechart.PieChartComponent

public class PieChartComponent
extends WorkspaceComponent

Pie chart component.

Constructor Summary

Constructors

Constructor and Description
PieChartComponent(java.lang.String name) Create new PieChart Component.
PieChartComponent(java.lang.String name, PieChartModel model) Initializes a pie chart with a model.

Method Summary

Modifier and Type	Method and Description
void	closing() Perform cleanup after closing.
PieChartModel	getModel()
java.lang.Object	getObjectFromKey(java.lang.String objectKey) Finds objects based on a key.
java.util.List<PotentialConsumer>	getPotentialConsumers() Return the potential consumers associated with this component.
java.lang.String	getXML() Override for use with open service.
boolean	hasChangedSinceLastSave() Returns true if it's changed since the last save.
static PieChartComponent	open(java.io.InputStream input, java.lang.String name, java.lang.String format) Streams file data for opening saved charts.
void	save(java.io.OutputStream output, java.lang.String format) Used when saving a workspace.
void	update() Called by Workspace to update the state of the component.

Methods inherited from class org.simbrain.workspace.WorkspaceComponent

addAttributeListener, addConsumerType, addProducerType, addWorkspaceComponentListener, close, couplingAdded, couplingRemoved, fireAttributeObjectRemoved, fireAttributeTypeVisibilityChanged, fireComponentToggleEvent, fireGuiToggleEvent, firePotentialAttributesChanged, fireUpdateEvent, getAttributeManager, getConsumerTypes, getCurrentFile, getDefaultFormat, getFormats, getKeyFromObject, getLocks, getLogger, getName, getPotentialProducers, getProducerTypes, getSerializePriority, getSimpleName, getUpdateOn, getUpdateParts, getVisibleConsumerTypes, getVisibleProducerTypes, getWorkspace, getWorkspaceComponentListeners, isGuiOn, removeAttributeListener, removeWorkspaceComponentListener, setChangedSinceLastSave, setCurrentFile, setGuiOn, setLogger, setName, setSerializePriority, setUpdateOn, setWorkspace, stopped, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PieChartComponent

public PieChartComponent(java.lang.String name)

Create new PieChart Component.

Parameters:

name - of chart

PieChartComponent

public PieChartComponent(java.lang.String name,
                         PieChartModel model)

Initializes a pie chart with a model. Used in deserializing.

Parameters:

name - name of component

model - to use for the plot

Method Detail

getPotentialConsumers

public java.util.List<PotentialConsumer> getPotentialConsumers()

Description copied from class: WorkspaceComponent

Return the potential consumers associated with this component. Subclasses should override this to make their consumers available.

Overrides:

getPotentialConsumers in class WorkspaceComponent

Returns:

the consumer list.

getObjectFromKey

public java.lang.Object getObjectFromKey(java.lang.String objectKey)

Description copied from class: WorkspaceComponent

Finds objects based on a key. Used in deserializing attributes. Any class that produces attributes should override this for serialization.

Overrides:

getObjectFromKey in class WorkspaceComponent

Parameters:

objectKey - String key

Returns:

the corresponding object

open

public static PieChartComponent open(java.io.InputStream input,
                                     java.lang.String name,
                                     java.lang.String format)

Streams file data for opening saved charts.

Parameters:

input - stream

name - file name

format - format

Returns:

component to be opened

getModel

public PieChartModel getModel()

Returns:

the model.

save

public void save(java.io.OutputStream output,
                 java.lang.String format)

Used when saving a workspace. All changed workspace components are saved using this method.

Specified by:

save in class WorkspaceComponent

Parameters:

output - the stream of data to write the data to.

format - a key used to define the requested format.

hasChangedSinceLastSave

public boolean hasChangedSinceLastSave()

Description copied from class: WorkspaceComponent

Returns true if it's changed since the last save.

Overrides:

hasChangedSinceLastSave in class WorkspaceComponent

Returns:

the changedSinceLastSave

closing

public void closing()

Description copied from class: WorkspaceComponent

Perform cleanup after closing.

Specified by:

closing in class WorkspaceComponent

update

public void update()

Description copied from class: WorkspaceComponent

Called by Workspace to update the state of the component.

Overrides:

update in class WorkspaceComponent

getXML

public java.lang.String getXML()

Description copied from class: WorkspaceComponent

Override for use with open service.

Overrides:

getXML in class WorkspaceComponent

Returns:

xml string representing stored file.