frysk.gui.monitor
Class LiaisonItem

java.lang.Object
  frysk.gui.monitor.GuiObject
      frysk.gui.monitor.LiaisonItem

All Implemented Interfaces:

SaveableXXX

Direct Known Subclasses:

Action, Filter

public abstract class LiaisonItem
extends GuiObject
implements SaveableXXX

An item that can be added to a LiaisonPoint. An item can either be an Action or a Filter.

Field Summary

int	needInfo
protected Runnable	runnable

Fields inherited from class frysk.gui.monitor.GuiObject

propertiesChanged

Constructor Summary

LiaisonItem()

LiaisonItem(LiaisonItem other)

LiaisonItem(String name, String toolTip)

Method Summary

abstract String	getArgument() uset to get the item's argument
abstract ObservableLinkedList	getArgumentCompletionList() If the item whishes to have a completion list for its arguments then it can return an observable linked list describing the list of possible arguments.
abstract GuiObject	getCopy()
void	load(Element node) To load a stored property one does this: String someString = node.getAttributeValue("someString"); To load @link frysk.gui.monitor.SaveableXXX one gets the appropriet node and tells that object to load itself from that node.
void	save(Element node) Save object to the given node Saving Conventions: If this object has a property such as a String, char, int, etc, that is saved by using node.setAttribute("someProperty", someProperty); If this object contains composing @link frysk.gui.monitor.SaveableXXX then a node is created for that and that object is told to save itself to that node.
abstract boolean	setArgument(String argument)

Methods inherited from class frysk.gui.monitor.GuiObject

dontSaveObject, doSaveObject, getName, getSummary, getToolTip, setName, setSummay, setToolTip, shouldSaveObject, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface frysk.gui.monitor.SaveableXXX

dontSaveObject, doSaveObject, shouldSaveObject

Field Detail

runnable

protected Runnable runnable

needInfo

public int needInfo

Constructor Detail

LiaisonItem

public LiaisonItem()

LiaisonItem

public LiaisonItem(LiaisonItem other)

LiaisonItem

public LiaisonItem(String name,
                   String toolTip)

Method Detail

getCopy

public abstract GuiObject getCopy()

Overrides:

getCopy in class GuiObject

setArgument

public abstract boolean setArgument(String argument)

getArgument

public abstract String getArgument()

uset to get the item's argument

Returns:

the argument, null if the object takes no argument

getArgumentCompletionList

public abstract ObservableLinkedList getArgumentCompletionList()

If the item whishes to have a completion list for its arguments then it can return an observable linked list describing the list of possible arguments. Otherwise just return null.

Returns:

save

public void save(Element node)

Description copied from interface: SaveableXXX

Save object to the given node Saving Conventions: If this object has a property such as a String, char, int, etc, that is saved by using node.setAttribute("someProperty", someProperty); If this object contains composing @link frysk.gui.monitor.SaveableXXX then a node is created for that and that object is told to save itself to that node. Example: Element filtersNode = new Element("filtersList"); this.filtersList.save(filtersNode); node.addContent(filtersNode); Be careful some times one wants to save the objects name rather than the object itself, and then use the name to later recreate that object via a managers. Like observers for instance. Perhaps objects such as these should be smart enough to use a manager to save/load themselves, that way an api client doesnt have to worry ... one day :).

Specified by:

save in interface SaveableXXX

Overrides:

save in class GuiObject

load

public void load(Element node)

Description copied from interface: SaveableXXX

To load a stored property one does this: String someString = node.getAttributeValue("someString"); To load @link frysk.gui.monitor.SaveableXXX one gets the appropriet node and tells that object to load itself from that node. Example: Element filtersNode = node.getChild("filtersList"); this.filtersList.load(filtersNode);

Specified by:

load in interface SaveableXXX

Overrides:

load in class GuiObject