org.simbrain.workspace.updater

Class UpdateComponent

java.lang.Object

org.simbrain.workspace.updater.UpdateComponent

All Implemented Interfaces:

UpdateAction

public class UpdateComponent
extends java.lang.Object
implements UpdateAction

Update a specific workspace component.

Author:

jyoshimi

Constructor Summary

Constructors

Constructor and Description
UpdateComponent(WorkspaceUpdater updater, WorkspaceComponent component)

Method Summary

Modifier and Type	Method and Description
WorkspaceComponent	getComponent() Returns a reference to this component.
java.lang.String	getDescription() Provide a String description of this update method.
java.lang.String	getLongDescription() Provide a longer description for tooltips, etc.
void	invoke() Invoke this action.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateComponent

public UpdateComponent(WorkspaceUpdater updater,
                       WorkspaceComponent component)

Parameters:

updater -

component - component to update

Method Detail

invoke

public void invoke()

Invoke this action.

Specified by:

invoke in interface UpdateAction

getDescription

public java.lang.String getDescription()

Provide a String description of this update method.

Specified by:

getDescription in interface UpdateAction

Returns:

the update description

getLongDescription

public java.lang.String getLongDescription()

Description copied from interface: UpdateAction

Provide a longer description for tooltips, etc.

Specified by:

getLongDescription in interface UpdateAction

Returns:

the update description

getComponent

public WorkspaceComponent getComponent()

Returns a reference to this component.

Returns:

the component