JComponentPack 1.5.0

com.zfqjava.swing
Class WorkBook

java.lang.Object
  extended by com.zfqjava.swing.WorkBook
All Implemented Interfaces:
ListModel, SingleSelectionModel

public class WorkBook
extends Object
implements ListModel, SingleSelectionModel

WorkBook


Field Summary
protected  SwingPropertyChangeSupport changeSupport
          If any PropertyChangeListeners have been registered, the changeSupport field describes them.
protected  EventListenerList listenerList
           
 
Constructor Summary
WorkBook()
          Constructs a empty workbook.
WorkBook(WorkSheet[] sheets)
          Constructs a workbook with the specified worksheets.
 
Method Summary
 void addChangeListener(ChangeListener listener)
           
 void addListDataListener(ListDataListener l)
          Adds a listener to the list that's notified each time a change to the data model occurs.
 void addPropertyChangeListener(PropertyChangeListener listener)
          Adds a PropertyChangeListener to the listener list.
 void addSheet(int index, WorkSheet sheet)
          Adds the worksheet to this workbook.
 void addSheet(WorkSheet sheet)
          Adds the worksheet to this workbook.
 void clearSelection()
           
protected  void firePropertyChange(String propertyName, Object oldValue, Object newValue)
          Supports reporting bound property changes.
 ChangeListener[] getChangeListeners()
          Returns an array of all the change listeners registered on this DefaultSingleSelectionModel.
 Map getDocumentProperties()
          Returns the document properties.
 Object getElementAt(int index)
           
 ListDataListener[] getListDataListeners()
          Returns an array of all the list data listeners registered on this AbstractListModel.
 EventListener[] getListeners(Class listenerType)
          Returns an array of all the objects currently registered as FooListeners upon this model.
 List getNamedRangeList()
          Returns all named cell as a List.
 PropertyChangeListener[] getPropertyChangeListeners()
          Returns an array of all the PropertyChangeListeners added to this ResultSetTableModel with addPropertyChangeListener().
 int getSelectedIndex()
           
 WorkSheet getSelectedSheet()
           
 WorkSheet getSheet(int index)
          Returns the worksheet at the specified index.
 int getSheetCount()
          Returns the sheet count.
 int getSize()
           
 int indexOfSheet(String name)
          Returns the index of the specified sheet.
 int indexOfSheet(WorkSheet sheet)
          Returns the index of the specified sheet.
 boolean isSelected()
           
 void removeChangeListener(ChangeListener listener)
           
 void removeListDataListener(ListDataListener l)
          Removes a listener from the list that's notified each time a change to the data model occurs.
 void removePropertyChangeListener(PropertyChangeListener listener)
          Removes a PropertyChangeListener from the listener list.
 void removeSheet(int index)
          Removes the worksheet from this workbook.
 void setDocumentProperties(Map map)
          Sets the document properties.
 void setNamedRangeList(List namedRangeList)
          Sets the named cell list.
 void setSelectedIndex(int index)
           
 void setSheet(int index, WorkSheet sheet)
          Sets the worksheet to sheet at the specified index.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

listenerList

protected EventListenerList listenerList

changeSupport

protected SwingPropertyChangeSupport changeSupport
If any PropertyChangeListeners have been registered, the changeSupport field describes them.

Constructor Detail

WorkBook

public WorkBook()
Constructs a empty workbook.


WorkBook

public WorkBook(WorkSheet[] sheets)
Constructs a workbook with the specified worksheets.

Parameters:
sheets - the worksheets
Method Detail

getSheetCount

public int getSheetCount()
Returns the sheet count.

Returns:
the sheet count

getSheet

public WorkSheet getSheet(int index)
Returns the worksheet at the specified index.


indexOfSheet

public int indexOfSheet(WorkSheet sheet)
Returns the index of the specified sheet.

Returns:
the index of the specified sheet
Since:
JDataGrid 1.4

indexOfSheet

public int indexOfSheet(String name)
Returns the index of the specified sheet.

Returns:
the index of the specified sheet
Since:
JDataGrid 1.4

setSheet

public void setSheet(int index,
                     WorkSheet sheet)
Sets the worksheet to sheet at the specified index.

Parameters:
index - the sheet index
sheet - the worksheet
Since:
JDataGrid 2.0

addSheet

public void addSheet(WorkSheet sheet)
Adds the worksheet to this workbook.

Parameters:
sheet -
Since:
JDataGrid 2.0

addSheet

public void addSheet(int index,
                     WorkSheet sheet)
Adds the worksheet to this workbook.

Parameters:
index - the worksheet index
sheet -
Since:
JDataGrid 2.0

removeSheet

public void removeSheet(int index)
Removes the worksheet from this workbook.

Parameters:
index - the worksheet index
Since:
JDataGrid 2.0

addListDataListener

public void addListDataListener(ListDataListener l)
Adds a listener to the list that's notified each time a change to the data model occurs.

Specified by:
addListDataListener in interface ListModel
Parameters:
l - the ListDataListener to be added
Since:
JDataGrid 2.0

removeListDataListener

public void removeListDataListener(ListDataListener l)
Removes a listener from the list that's notified each time a change to the data model occurs.

Specified by:
removeListDataListener in interface ListModel
Parameters:
l - the ListDataListener to be removed
Since:
JDataGrid 2.0

getListDataListeners

public ListDataListener[] getListDataListeners()
Returns an array of all the list data listeners registered on this AbstractListModel.

Returns:
all of this model's ListDataListeners, or an empty array if no list data listeners are currently registered
Since:
JDataGrid 2.0
See Also:
addListDataListener(javax.swing.event.ListDataListener), removeListDataListener(javax.swing.event.ListDataListener)

getListeners

public EventListener[] getListeners(Class listenerType)
Returns an array of all the objects currently registered as FooListeners upon this model. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a list model m for its list data listeners with the following code:

ListDataListener[] ldls = (ListDataListener[])(m.getListeners(ListDataListener.class));
If no such listeners exist, this method returns an empty array.

Parameters:
listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
Returns:
an array of all objects registered as FooListeners on this model, or an empty array if no such listeners have been added
Throws:
ClassCastException - if listenerType doesn't specify a class or interface that implements java.util.EventListener
Since:
JDataGrid 2.0
See Also:
getListDataListeners()

getDocumentProperties

public Map getDocumentProperties()
Returns the document properties.

Returns:
the document properties
Since:
JDataGrid 2.0

setDocumentProperties

public void setDocumentProperties(Map map)
Sets the document properties.

Parameters:
map - the document properties
Since:
JDataGrid 2.0

getSize

public int getSize()
Specified by:
getSize in interface ListModel

getElementAt

public Object getElementAt(int index)
Specified by:
getElementAt in interface ListModel

firePropertyChange

protected void firePropertyChange(String propertyName,
                                  Object oldValue,
                                  Object newValue)
Supports reporting bound property changes. This method can be called when a bound property has changed and it will send the appropriate PropertyChangeEvent to any registered PropertyChangeListeners.


addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list. The listener is registered for all properties.

A PropertyChangeEvent will get fired in response to setting a bound property, e.g. setFont, setBackground, or setForeground. Note that if the current component is inheriting its foreground, background, or font from its container, then no event will be fired in response to a change in the inherited property.

Parameters:
listener - The PropertyChangeListener to be added

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.

Parameters:
listener - the PropertyChangeListener to be removed

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()
Returns an array of all the PropertyChangeListeners added to this ResultSetTableModel with addPropertyChangeListener().

Returns:
all of the PropertyChangeListeners added or an empty array if no listeners have been added

getSelectedSheet

public WorkSheet getSelectedSheet()
Since:
JDataGrid 2.0

getSelectedIndex

public int getSelectedIndex()
Specified by:
getSelectedIndex in interface SingleSelectionModel
Since:
JDataGrid 2.0

setSelectedIndex

public void setSelectedIndex(int index)
Specified by:
setSelectedIndex in interface SingleSelectionModel

clearSelection

public void clearSelection()
Specified by:
clearSelection in interface SingleSelectionModel

isSelected

public boolean isSelected()
Specified by:
isSelected in interface SingleSelectionModel

addChangeListener

public void addChangeListener(ChangeListener listener)
Specified by:
addChangeListener in interface SingleSelectionModel

removeChangeListener

public void removeChangeListener(ChangeListener listener)
Specified by:
removeChangeListener in interface SingleSelectionModel

getChangeListeners

public ChangeListener[] getChangeListeners()
Returns an array of all the change listeners registered on this DefaultSingleSelectionModel.

Returns:
all of this model's ChangeListeners or an empty array if no change listeners are currently registered
See Also:
addChangeListener(javax.swing.event.ChangeListener), removeChangeListener(javax.swing.event.ChangeListener)

toString

public String toString()
Overrides:
toString in class Object

getNamedRangeList

public List getNamedRangeList()
Returns all named cell as a List.

Returns:
all named cell as a List
Since:
JDataGrid 2.0
See Also:
setNamedRangeList(java.util.List)

setNamedRangeList

public void setNamedRangeList(List namedRangeList)
Sets the named cell list.

Parameters:
namedCell3DList - the named cell list
Since:
JDataGrid 2.0
See Also:
getNamedRangeList()

JComponentPack 1.5.0

Send your Feedback
JComponentPack 1.5.0
Copyright © 2001-2007 Extreme Component, Inc. All rights reserved.