frysk.gui.monitor
Class GuiObject

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

All Implemented Interfaces:

SaveableXXX

Direct Known Subclasses:

Combo, CoreDebugLogRecord, DebugProcess, Event, EventViewerWidget, GuiCoreObjectWrapper, LiaisonItem, LiaisonPoint, ObserverRoot, Session, Tag, Tagset, TimeLineEndEvent, TimeLineStartEvent

public class GuiObject
extends Object
implements SaveableXXX

A GuiObject is one that has a name and a tooltip.

Field Summary

GuiObservable

propertiesChanged

Constructor Summary

GuiObject()

GuiObject(String name, String toolTip)

Method Summary

void	dontSaveObject() object will not be saved if save is called
void	doSaveObject() Object will be savable if save is called
String	getName()
String	getSummary()
String	getToolTip()
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.
void	setName(String name)
void	setSummay(String summary)
void	setToolTip(String toolTip)
boolean	shouldSaveObject() queried to see if this object should be saved or not
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

propertiesChanged

public final GuiObservable propertiesChanged

Constructor Detail

GuiObject

public GuiObject(String name,
                 String toolTip)

GuiObject

public GuiObject()

Method Detail

setName

public void setName(String name)

getName

public String getName()

setToolTip

public void setToolTip(String toolTip)

getToolTip

public String getToolTip()

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

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

shouldSaveObject

public boolean shouldSaveObject()

Description copied from interface: SaveableXXX

queried to see if this object should be saved or not

Specified by:

shouldSaveObject in interface SaveableXXX

Returns:

wether this object should be saved or not

doSaveObject

public void doSaveObject()

Description copied from interface: SaveableXXX

Object will be savable if save is called

Specified by:

doSaveObject in interface SaveableXXX

dontSaveObject

public void dontSaveObject()

Description copied from interface: SaveableXXX

object will not be saved if save is called

Specified by:

dontSaveObject in interface SaveableXXX

toString

public String toString()

Overrides:

toString in class Object

getSummary

public String getSummary()

setSummay

public void setSummay(String summary)