org.simbrain.docviewer

Class DocViewerComponent

java.lang.Object

org.simbrain.workspace.WorkspaceComponent

org.simbrain.docviewer.DocViewerComponent

public class DocViewerComponent
extends WorkspaceComponent

Component corresponding to a Document Viewer.

Constructor Summary

Constructors

Constructor and Description
DocViewerComponent() Construct a new document viewer component.
DocViewerComponent(java.lang.String name) Construct a new document viewer component with a specified title.

Method Summary

Modifier and Type	Method and Description
void	closing() Perform cleanup after closing.
java.util.List<? extends java.lang.String>	getFormats() Returns a list of the formats that this component supports.
java.lang.String	getText()
static DocViewerComponent	open(java.io.InputStream input, java.lang.String name, java.lang.String format) Opens a saved component.
void	save(java.io.OutputStream output, java.lang.String format) Used when saving a workspace.
void	setText(java.lang.String text)
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, getKeyFromObject, getLocks, getLogger, getName, getObjectFromKey, getPotentialConsumers, getPotentialProducers, getProducerTypes, getSerializePriority, getSimpleName, getUpdateOn, getUpdateParts, getVisibleConsumerTypes, getVisibleProducerTypes, getWorkspace, getWorkspaceComponentListeners, getXML, hasChangedSinceLastSave, 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

DocViewerComponent

public DocViewerComponent()

Construct a new document viewer component.

DocViewerComponent

public DocViewerComponent(java.lang.String name)

Construct a new document viewer component with a specified title.

Parameters:

name - title for frame this is displayed in

Method Detail

open

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

Opens a saved component. There isn't much to do here since currently there is nothing to persist with a console. This just ensures that a component is created and (in the gui) presented.

Parameters:

input - stream

name - name of file

format - format

Returns:

component to be opened

save

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

Description copied from class: WorkspaceComponent

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.

update

public void update()

Description copied from class: WorkspaceComponent

Called by Workspace to update the state of the component.

Overrides:

update in class WorkspaceComponent

closing

public void closing()

Description copied from class: WorkspaceComponent

Perform cleanup after closing.

Specified by:

closing in class WorkspaceComponent

getText

public java.lang.String getText()

Returns:

the text

setText

public void setText(java.lang.String text)

Parameters:

text - the text to set

getFormats

public java.util.List<? extends java.lang.String> getFormats()

Description copied from class: WorkspaceComponent

Returns a list of the formats that this component supports.

The default behavior is to return an empty list. This means that there is one format.

Overrides:

getFormats in class WorkspaceComponent

Returns:

a list of the formats that this component supports.