Interface cern.lhcias.csgui.interfaces.TagsView

public interface TagsView
extends TagChangeListener


This interface defines a component used to visualize in some means the behaviour of the
tags. Typical implementations of this interface could be graphical trending system,
alarm display windows, control system's supervisory synoptics, the representation of a led,
the representation of a dial, ....
A TagsView must be an awt component of some sort (such as a canvas or a panel) to be
able to be inserted in windows or other components. Some TagsViews may then be containers
for other TagsViews.

VIEW TYPE:
Each TagsView implements one or several "view types", which is a name describing
the represention. Using the methods getType(), getPossibleTypes() and
doYouImplement(String type)the system can dynamically make the correspondance
between a representation asked by a user and the component class which offers
this kind of representation.
This "view type" can be different from the class' name enabling a single class to
offers different view types.
If the system doesn't find a preloaded class implementing the required view type, it will
try to dynamically find and load a class which name is equal to the view type.

CONFIGURATION:
To enable serialization and to easily configure the TagsView, each of them must be implements
the methods toString() and setConfig(String config). By doing so, TagsViews don't have to
bother about saving or loading their configuration. This will be handled by the system
(see configurationMgr).

EVENTS:
It is assumed that the TagsView sends the TagClickedEvent when the operator clicks on the
representation of a Tag, enabling so a uniform and easy behaviour of the interface.


Method Index

 o addAlarmListener(AlarmListener)
 
 o addMouseListener(MouseListener)
 
 o addOpenViewListener(OpenViewListener)
 
 o addTag(String)
adds the tag named tagName to the list of Tags shown in this TagsView.
 o addTag(TagsView)
adds the TagsView TVcomponent or all the tags shown in TVcomponent to the list of Tags shown in this TagsView.
 o addTag(Vector)
adds the list of tags which names are in tagNames to the list of Tags shown in this TagsView.
 o addTagClickedListener(TagClickedListener)
 
 o doYouImplement(String)
returns true if this TagsView offers the "view type" type.
 o getBounds()
 
 o getComponentNb()
returns the number of components (TagsViews), if any, included as subcomponents of this TagsView.
 o getComponentsList()
returns the list of components (TagsViews), if any, included as subcomponents of this TagsView.
 o getLocalTagNames()
returns the names of all the tags shown directly in this TagsView, but not shown in subcompoennts.
 o getPossibleTypes()
returns the list of possible "view types" (or representations) offered by this TagsView.
 o getPreferredSize()
 
 o getTagNames()
returns the names of all the tags, recursively, shown in this TagsView.
 o getType()
returns the current implemented "view type"
 o instantiate(TagArrays, String, TagChangeAdapter, TagClickedAdapter, OpenViewAdapter, configurationMgr, AlarmAdapter)
To be called once after instantiating the class.
 o removeAlarmListener(AlarmListener)
 
 o removeNotify()
 
 o removeOpenViewListener(OpenViewListener)
 
 o removeTag(String)
removes the tag named tagName from the list of Tags shown in this TagsView.
 o removeTag(TagsView)
removes the TagsView TVcomponent or all the tags shown in TVcomponent from the list of Tags shown in this TagsView.
 o removeTag(Vector)
removes the list of tags which names are in tagNames from the list of Tags shown in this TagsView.
 o removeTagClickedListener(TagClickedListener)
 
 o repaint()
 
 o setBounds(int, int, int, int)
 
 o setConfig(String)
configure the TagsView with a String
 o setProperty(String, String, String)
 
 o toString()
returns the configuration of the TagsView as a String.

Methods

 o instantiate

 public abstract void instantiate(TagArrays TA,
                                  String configname,
                                  TagChangeAdapter adapter,
                                  TagClickedAdapter cadapter,
                                  OpenViewAdapter opadapter,
                                  configurationMgr cM,
                                  AlarmAdapter aA)
To be called once after instantiating the class.

 o removeNotify

 public abstract void removeNotify()

 o setBounds

 public abstract void setBounds(int x,
                                int y,
                                int width,
                                int height)

 o getBounds

 public abstract Rectangle getBounds()

 o getPreferredSize

 public abstract Dimension getPreferredSize()

 o repaint

 public abstract void repaint()

 o toString

 public abstract String toString()
returns the configuration of the TagsView as a String.
Overrides:
toString in class Object

 o setConfig

 public abstract void setConfig(String config)
configure the TagsView with a String

 o addTag

 public abstract void addTag(String tagName)
adds the tag named tagName to the list of Tags shown in this TagsView.

 o addTag

 public abstract void addTag(Vector tagNames)
adds the list of tags which names are in tagNames to the list of Tags shown in this TagsView.

 o addTag

 public abstract void addTag(TagsView TVcomponent)
adds the TagsView TVcomponent or all the tags shown in TVcomponent to the list of Tags shown in this TagsView.

 o removeTag

 public abstract void removeTag(String tagName)
removes the tag named tagName from the list of Tags shown in this TagsView.

 o removeTag

 public abstract void removeTag(Vector tagNames)
removes the list of tags which names are in tagNames from the list of Tags shown in this TagsView.

 o removeTag

 public abstract void removeTag(TagsView TVcomponent)
removes the TagsView TVcomponent or all the tags shown in TVcomponent from the list of Tags shown in this TagsView.

 o setProperty

 public abstract void setProperty(String tagName,
                                  String tagProperty,
                                  String propertyValue)

 o addTagClickedListener

 public abstract void addTagClickedListener(TagClickedListener listener)

 o removeTagClickedListener

 public abstract void removeTagClickedListener(TagClickedListener listener)

 o addOpenViewListener

 public abstract void addOpenViewListener(OpenViewListener listener)

 o removeOpenViewListener

 public abstract void removeOpenViewListener(OpenViewListener listener)

 o addMouseListener

 public abstract void addMouseListener(MouseListener cMouse)

 o addAlarmListener

 public abstract void addAlarmListener(AlarmListener listener)

 o removeAlarmListener

 public abstract void removeAlarmListener(AlarmListener listener)

 o getComponentNb

 public abstract int getComponentNb()
returns the number of components (TagsViews), if any, included as subcomponents of this TagsView. Just one level. Not recursive

 o getComponentsList

 public abstract Vector getComponentsList()
returns the list of components (TagsViews), if any, included as subcomponents of this TagsView. Just one level. Not recursive

 o getTagNames

 public abstract Vector getTagNames()
returns the names of all the tags, recursively, shown in this TagsView.

 o getLocalTagNames

 public abstract Vector getLocalTagNames()
returns the names of all the tags shown directly in this TagsView, but not shown in subcompoennts.

 o getType

 public abstract String getType()
returns the current implemented "view type"

 o getPossibleTypes

 public abstract Vector getPossibleTypes()
returns the list of possible "view types" (or representations) offered by this TagsView.

 o doYouImplement

 public abstract boolean doYouImplement(String type)
returns true if this TagsView offers the "view type" type.