conient/datacomponents/VisibleDataComponent.java

/* 
 * i-scream central monitoring system
 * Copyright (C) 2000-2002 i-scream
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

//---PACKAGE DECLARATION---
package uk.org.iscream.cms.conient.datacomponents;

//---IMPORTS---
import javax.swing.JPanel;
import uk.org.iscream.cms.server.util.XMLPacket;

/**
 * This is the abstract class for all
 * data components that will display data on the screen.
 * <br><br>
 * This is an abstract class based on a JPanel ensuring
 * that all components can be handled like a JPanel.  It
 * extends the JPanel by adding a specific setValue function
 * this tells the component to update its data display however it
 * sees fit.  This value is the string value obtained from an
 * XML packet, it is up to the component to convert and display
 * as it chooses, if there is a problem doing this then it
 * can throw a DataFormatException to indicate the problem.
 * <br><br>
 * As all extending components will be data components, it also
 * implements the DataComponent interface, which should thus be 
 * imlemented by all extending compoents.
 * <br><br>
 * All extending components should implement the run() method of
 * this class as it implements the Runnable interface.  This run
 * method should contain the code to update the actual GUI
 * component of this class.  In the setValue() method which they
 * should also be implementing, the code should add the
 * data component to the Swing Event Dispatch queue. eg,
 * <br><br>
 * SwingUtilities.invokeLater(this);
 * 
 *
 * @author  $Author: tdb $
 * @version $Id: VisibleDataComponent.java,v 1.6 2001/05/29 17:41:32 tdb Exp $
 */
public abstract class VisibleDataComponent extends JPanel implements Runnable, DataComponent {
    
//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.6 $";
    
//---STATIC METHODS---
    
//---CONSTRUCTORS---

//---PUBLIC METHODS---

//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---

//---ATTRIBUTES---

//---STATIC ATTRIBUTES---

}
Revision:	1.7
Committed:	Sat May 18 18:15:56 2002 UTC (22 years ago) by tdb
Branch:	MAIN
Changes since 1.6:	+22 -3 lines
Log Message:	i-scream is now licensed under the GPL. I've added the GPL headers to every source file, and put a full copy of the license in the appropriate places. I think I've covered everything. This is going to be a mad commit ;)
#	Content
1	/*
2	* i-scream central monitoring system
3	* Copyright (C) 2000-2002 i-scream
4	*
5	* This program is free software; you can redistribute it and/or
6	* modify it under the terms of the GNU General Public License
7	* as published by the Free Software Foundation; either version 2
8	* of the License, or (at your option) any later version.
9	*
10	* This program is distributed in the hope that it will be useful,
11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13	* GNU General Public License for more details.
14	*
15	* You should have received a copy of the GNU General Public License
16	* along with this program; if not, write to the Free Software
17	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18	*/
19
20	//---PACKAGE DECLARATION---
21	package uk.org.iscream.cms.conient.datacomponents;
22
23	//---IMPORTS---
24	import javax.swing.JPanel;
25	import uk.org.iscream.cms.server.util.XMLPacket;
26
27	/**
28	* This is the abstract class for all
29	* data components that will display data on the screen.
30	* <br><br>
31	* This is an abstract class based on a JPanel ensuring
32	* that all components can be handled like a JPanel. It
33	* extends the JPanel by adding a specific setValue function
34	* this tells the component to update its data display however it
35	* sees fit. This value is the string value obtained from an
36	* XML packet, it is up to the component to convert and display
37	* as it chooses, if there is a problem doing this then it
38	* can throw a DataFormatException to indicate the problem.
39	* <br><br>
40	* As all extending components will be data components, it also
41	* implements the DataComponent interface, which should thus be
42	* imlemented by all extending compoents.
43	* <br><br>
44	* All extending components should implement the run() method of
45	* this class as it implements the Runnable interface. This run
46	* method should contain the code to update the actual GUI
47	* component of this class. In the setValue() method which they
48	* should also be implementing, the code should add the
49	* data component to the Swing Event Dispatch queue. eg,
50	* <br><br>
51	* SwingUtilities.invokeLater(this);
52	*
53	*
54	* @author $Author: tdb $
55	* @version $Id: VisibleDataComponent.java,v 1.6 2001/05/29 17:41:32 tdb Exp $
56	*/
57	public abstract class VisibleDataComponent extends JPanel implements Runnable, DataComponent {
58
59	//---FINAL ATTRIBUTES---
60
61	/**
62	* The current CVS revision of this class
63	*/
64	public final String REVISION = "$Revision: 1.6 $";
65
66	//---STATIC METHODS---
67
68	//---CONSTRUCTORS---
69
70	//---PUBLIC METHODS---
71
72	//---PRIVATE METHODS---
73
74	//---ACCESSOR/MUTATOR METHODS---
75
76	//---ATTRIBUTES---
77
78	//---STATIC ATTRIBUTES---
79
80	}