Class ncsa.horizon.modules.Spreadsheet
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class ncsa.horizon.modules.Spreadsheet

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----ncsa.horizon.modules.Spreadsheet

public class Spreadsheet
extends Panel
This is a spreadsheet component. To use this class, you may write a derived class for your purpose, especifilly overwrite the "getSpreadsheetData" method to organize the displayed spreadsheet data. The data may be a simple dataset or complex metadata which is an object of another class(component). See followed example:
 Suppose YourSpreadsheet is a subclass of Spreadsheet.
 // define a new YourSpreadsheet object with a new object
 YourSpreadsheet sp = new  YourSpreadsheet(new ImageTest("test.gif"));
 // define a bounding box for this image(subset of a image)
 Rectangle rect = new Rectangle(1,1,20,30);
 // set spreadsheet variables based on this bounding box
 // set first line number of spreadsheet
 sp.setFirstLineNumber(rect.y);
 // set spreadsheet row number
 sp.setRowNumber(rect.height);
 // set spreadsheet colnum number
 sp.setColnumNumber(rect.width);
 // specify spreadsheet colnum features
 String[] cellName = new String[rect.width];
 int[]    cellType = new int[rect.width];
 int[]    cellOrder= new int[rect.width];
 // set cell name, cell type , cell order...
 int firstColnum = rect.x;
 // simple spreadsheet setting
 for (int i=0; i

Variable Index

 o cellName
colnum name
 o cellOrder
colnum order
 o cellType
colnum data number type
 o colnumInfoCanvas
the spreadsheet label canvas
 o data
spreadsheet data set
 o dataCanvas
the spreadsheet canvas
 o DFNT_CHAR
 o DFNT_CHAR16
No supported
 o DFNT_CHAR8
char
 o DFNT_DOUBLE
 o DFNT_FLOAT
 o DFNT_FLOAT32
float
 o DFNT_FLOAT64
double
 o DFNT_INT16
short
 o DFNT_INT32
interger
 o DFNT_INT8
8-bit integer
 o DFNT_UCHAR
 o DFNT_UCHAR16
 o DFNT_UCHAR8
unsigned char
 o DFNT_UINT16
unsigned interger
 o DFNT_UINT32
unsigned interger
 o DFNT_UINT8
unsigned 8-bit interger
 o FAIL
FAIL
 o firstLineNumber
the first row number of spreadsheet
 o hScrollbar
the scrollbar associated with the spreadsheet
 o numberOfColnum
spreadsheet colnum number
 o numberOfRow
spreadsheet row number
 o obj
an object that spreadsheet will communicated with
 o rowInfoCanvas
the spreadsheet label canvas
 o title
spreadsheet title
 o vScrollbar
the scrollbar associated with the spreadsheet

Constructor Index

 o Spreadsheet(Object)
new constructor of the class.

Method Index

 o createSpreadsheetGUI()
create Spreadsheet
 o getColnumName()
get spreadsheet colnum name
 o getColnumName(int)
get spreadsheet colnum name
 o getColnumNumber()
get spreadsheet colnum number
 o getColnumOrder()
get spreadsheet colnum order
 o getColnumOrder(int)
get spreadsheet colnum order
 o getColnumType()
get spreadsheet colnum type
 o getColnumType(int)
get spreadsheet colnum type
 o getDataTypeSize(int)
Return the size of the data number type
 o getFirstLineNumber()
return spreadsheet first line number
 o getRowNumber()
get spreadsheet row number
 o getSpreadsheetData()
Prepare the spreadsheet data after the spreadsheet frame has been setup .
 o getSpreadsheetTitle()
get spreadsheet title
 o handleEvent(Event)
Handles the event.
 o popup()
popup the new component actually
 o setColnumName(String[])
set spreadsheet colnum name
 o setColnumNumber(int)
set colnum number
 o setColnumOrder(int[])
set spreadsheet colnum order
 o setColnumType(int[])
set spreadsheet colnum type
 o setFirstLineNumber(int)
set spreadsheet first line number
 o setRowNumber(int)
set row number
 o setSpreadsheetTitle(String)
set title for this spreadsheet
 o updateSpreadsheet()
Update spreadsheet and repaint it

Variables

 o obj
  protected Object obj
an object that spreadsheet will communicated with
 o dataCanvas
  protected SpreadsheetData dataCanvas
the spreadsheet canvas
 o rowInfoCanvas
  protected SpreadsheetLabel rowInfoCanvas
the spreadsheet label canvas
 o colnumInfoCanvas
  protected SpreadsheetLabel colnumInfoCanvas
the spreadsheet label canvas
 o hScrollbar
  protected Scrollbar hScrollbar
the scrollbar associated with the spreadsheet
 o vScrollbar
  protected Scrollbar vScrollbar
the scrollbar associated with the spreadsheet
 o firstLineNumber
  protected int firstLineNumber
the first row number of spreadsheet
 o numberOfRow
  protected int numberOfRow
spreadsheet row number
 o numberOfColnum
  protected int numberOfColnum
spreadsheet colnum number
 o cellName
  protected String cellName[]
colnum name
 o cellType
  protected int cellType[]
colnum data number type
 o title
  protected String title
spreadsheet title
 o cellOrder
  protected int cellOrder[]
colnum order
 o data
  protected String data[][]
spreadsheet data set
 o DFNT_UCHAR8
  public final static int DFNT_UCHAR8
unsigned char
 o DFNT_UCHAR
  public final static int DFNT_UCHAR
 o DFNT_CHAR8
  public final static int DFNT_CHAR8
char
 o DFNT_CHAR
  public final static int DFNT_CHAR
 o DFNT_CHAR16
  public final static int DFNT_CHAR16
No supported
 o DFNT_UCHAR16
  public final static int DFNT_UCHAR16
 o DFNT_FLOAT32
  public final static int DFNT_FLOAT32
float
 o DFNT_FLOAT
  public final static int DFNT_FLOAT
 o DFNT_FLOAT64
  public final static int DFNT_FLOAT64
double
 o DFNT_DOUBLE
  public final static int DFNT_DOUBLE
 o DFNT_INT8
  public final static int DFNT_INT8
8-bit integer
 o DFNT_UINT8
  public final static int DFNT_UINT8
unsigned 8-bit interger
 o DFNT_INT16
  public final static int DFNT_INT16
short
 o DFNT_UINT16
  public final static int DFNT_UINT16
unsigned interger
 o DFNT_INT32
  public final static int DFNT_INT32
interger
 o DFNT_UINT32
  public final static int DFNT_UINT32
unsigned interger
 o FAIL
  public static int FAIL
FAIL

Constructors

 o Spreadsheet
  public Spreadsheet(Object obj)
new constructor of the class.
Parameters:
obj - an object

Methods

 o createSpreadsheetGUI
  public void createSpreadsheetGUI()
create Spreadsheet
 o getSpreadsheetTitle
  public String getSpreadsheetTitle()
get spreadsheet title
Returns:
a spreadsheet title
 o getFirstLineNumber
  public int getFirstLineNumber()
return spreadsheet first line number
Returns:
a first row number of spreadsheet
 o getRowNumber
  public int getRowNumber()
get spreadsheet row number
Returns:
the spreadsheet row number
 o setColnumNumber
  public void setColnumNumber(int num)
set colnum number
Parameters:
num - a colnum number of spreadsheet
 o getColnumNumber
  public int getColnumNumber()
get spreadsheet colnum number
Returns:
a colnum number of spreadsheet
 o setColnumName
  public void setColnumName(String name[])
set spreadsheet colnum name
Parameters:
name - a colnum name array of a spreadsheet
 o getColnumName
  public String[] getColnumName()
get spreadsheet colnum name
Returns:
a colnum name array of a spreadsheet
 o getColnumName
  public String getColnumName(int index)
get spreadsheet colnum name
Parameters:
index - the colnum name
Returns:
a specified colnum name
 o setColnumType
  public void setColnumType(int type[])
set spreadsheet colnum type
Parameters:
type - a colnum data type of a spreadsheet
 o getColnumType
  public int[] getColnumType()
get spreadsheet colnum type
Returns:
a colnum data type of a spreadsheet
 o getColnumType
  public int getColnumType(int index)
get spreadsheet colnum type
Parameters:
index - the colnum type
Returns:
a specified colnum data type of a spreadsheet
 o setColnumOrder
  public void setColnumOrder(int order[])
set spreadsheet colnum order
Returns:
a colnum order of a spreadsheet
 o getColnumOrder
  public int getColnumOrder(int index)
get spreadsheet colnum order
Parameters:
index - the colnum
Returns:
a specified colnum order
 o getColnumOrder
  public int[] getColnumOrder()
get spreadsheet colnum order
Returns:
a colnum order
 o getSpreadsheetData
  public void getSpreadsheetData()
Prepare the spreadsheet data after the spreadsheet frame has been setup . This method should be overwriten.
 o getDataTypeSize
  public int getDataTypeSize(int nt)
Return the size of the data number type
Parameters:
nt - the data number type
Returns:
the size otherwise FAIL
 o handleEvent
  public boolean handleEvent(Event evt)
Handles the event. Returns true if the event is handled and should not be passed to the parent of this component. The default event handler calls some helper methods to make life easier on the programmer.
Parameters:
evt - the event
Overrides:
handleEvent in class Component
See Also:
handleEvent
 o popup
  public void popup()
popup the new component actually
 o setFirstLineNumber
  public void setFirstLineNumber(int rownum)
set spreadsheet first line number
Parameters:
rownum - a first row number
 o setRowNumber
  public void setRowNumber(int rownum)
set row number
Parameters:
rownum - a row number of spreadsheet
 o setSpreadsheetTitle
  public void setSpreadsheetTitle(String title)
set title for this spreadsheet
Parameters:
title - a spreadsheet title
 o updateSpreadsheet
  public void updateSpreadsheet()
Update spreadsheet and repaint it

All Packages  Class Hierarchy  This Package  Previous  Next  Index