ScuflUIComponent

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> embl >> ebi >> escience >> [ scuflui overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.embl.ebi.escience.scuflui.ScuflUIComponent

SOURCE |

Download org.embl.ebi.escience.scuflui.ScuflUIComponent

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.embl.ebi.escience.scuflui
Interface ScuflUIComponent

All Known Implementing Classes:: DotTextArea, EnactorLaunchPanel, ScuflDiagram, ScuflModelExplorer, ScuflSemanticMarkupEditor, XScuflTextArea

public interface ScuflUIComponent

The interface implemented by all Scufl UI widgets specifying how they bind and detach from an instance of a ScuflModel. Any class implementing this interface must be a subclass of JComponent; unfortunately there's no way that I know of to enforce this constraint in the language, but if you don't stick to it your components won't work.

Method Summary

void attachToModel(org.embl.ebi.escience.scufl.ScuflModel model)
          Directs the implementing component to bind to the specified ScuflModel instance, refresh its internal state from the model and commence listening to events, maintaining its state as these events dictate.

void detachFromModel()
          Directs the implementing component to detach from the model, set its internal state to some suitable blank (i.e.

java.lang.String getName()
          Get the preferred name of this component, for titles in windows etc.

Method Detail

attachToModel

public void attachToModel(org.embl.ebi.escience.scufl.ScuflModel model)

Directs the implementing component to bind to the specified ScuflModel instance, refresh its internal state from the model and commence listening to events, maintaining its state as these events dictate.

detachFromModel

public void detachFromModel()

Directs the implementing component to detach from the model, set its internal state to some suitable blank (i.e. blank image, no text in a text field etc) and desist from listening to model events.

getName

public java.lang.String getName()

Get the preferred name of this component, for titles in windows etc.