net.sf.jett.model
Class WorkbookContext

java.lang.Object
  extended by net.sf.jett.model.WorkbookContext

public class WorkbookContext
extends java.lang.Object

A WorkbookContext object holds data relevant to the context of a Workbook.

Author:
Randy Gettman

Constructor Summary
WorkbookContext()
          Initializes things to null/0.
 
Method Summary
 java.util.List<CellListener> getCellListeners()
          Returns the CellListeners.
 java.util.Map<java.lang.String,java.util.List<CellRef>> getCellRefMap()
          Returns the cell reference map, a Map of cell key strings to Lists of CellRefs.
 CellStyleCache getCellStyleCache()
          Returns the CellStyleCache.
 java.util.List<java.lang.String> getFixedSizedCollectionNames()
          Returns the List of "fixed size" collection names.
 FontCache getFontCache()
          Returns the FontCache.
 java.util.Map<java.lang.String,Formula> getFormulaMap()
          Returns the formula map, a Map of formula keys to Formulas, with the keys of the format "sheetName!formula".
 java.util.List<java.lang.String> getNoImplicitProcessingCollectionNames()
          Returns the List of collection names on which NOT to perform implicit collections processing.
 TagLibraryRegistry getRegistry()
          Returns the TagLibraryRegistry.
 int getSequenceNbr()
          Returns the current sequence number.
 java.util.Map<java.lang.String,Style> getStyleMap()
          Returns the Map of style names to Styles.
 void incrSequenceNbr()
          Increments the current sequence number.
 void setCellListeners(java.util.List<CellListener> cellListeners)
          Sets the CellListeners.
 void setCellRefMap(java.util.Map<java.lang.String,java.util.List<CellRef>> cellRefMap)
          Sets the cell reference map, a Map of cell key strings to Lists of CellRefs.
 void setCellStyleCache(CellStyleCache cache)
          Sets the CellStyleCache.
 void setFixedSizeCollectionNames(java.util.List<java.lang.String> collNames)
          These named Collections have a known size and do not need to have other Cells shifted out of the way for its contents; space is already allocated.
 void setFontCache(FontCache cache)
          Sets the FontCache.
 void setFormulaMap(java.util.Map<java.lang.String,Formula> formulaMap)
          Sets the formula map, a Map of formula keys to Formulas, with the keys of the format "sheetName!formula".
 void setNoImplicitCollectionProcessingNames(java.util.List<java.lang.String> collNames)
          Turn off implicit collections processing for the given Collections specified by the given collection names.
 void setRegistry(TagLibraryRegistry registry)
          Sets the TagLibraryRegistry.
 void setStyleMap(java.util.Map<java.lang.String,Style> styleMap)
          Sets Map of style names to Styles.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkbookContext

public WorkbookContext()
Initializes things to null/0.

Method Detail

getRegistry

public TagLibraryRegistry getRegistry()
Returns the TagLibraryRegistry.

Returns:
The TagLibraryRegistry.

setRegistry

public void setRegistry(TagLibraryRegistry registry)
Sets the TagLibraryRegistry.

Parameters:
registry - The TagLibraryRegistry.

getCellListeners

public java.util.List<CellListener> getCellListeners()
Returns the CellListeners.

Returns:
The CellListeners.

setCellListeners

public void setCellListeners(java.util.List<CellListener> cellListeners)
Sets the CellListeners.

Parameters:
cellListeners - The CellListeners.

setFixedSizeCollectionNames

public void setFixedSizeCollectionNames(java.util.List<java.lang.String> collNames)
These named Collections have a known size and do not need to have other Cells shifted out of the way for its contents; space is already allocated.

Parameters:
collNames - A List of Collection names that don't need other Cells shifted out of the way for its contents.

getFixedSizedCollectionNames

public java.util.List<java.lang.String> getFixedSizedCollectionNames()
Returns the List of "fixed size" collection names.

Returns:
The List of "fixed size" collection names.

setNoImplicitCollectionProcessingNames

public void setNoImplicitCollectionProcessingNames(java.util.List<java.lang.String> collNames)
Turn off implicit collections processing for the given Collections specified by the given collection names.

Parameters:
collNames - The names of the Collections on which NOT to perform implicit collections processing.

getNoImplicitProcessingCollectionNames

public java.util.List<java.lang.String> getNoImplicitProcessingCollectionNames()
Returns the List of collection names on which NOT to perform implicit collections processing.

Returns:
The List of collection names on which NOT to perform implicit collections processing.

getFormulaMap

public java.util.Map<java.lang.String,Formula> getFormulaMap()
Returns the formula map, a Map of formula keys to Formulas, with the keys of the format "sheetName!formula".

Returns:
A Map of formula keys to Formulas.

setFormulaMap

public void setFormulaMap(java.util.Map<java.lang.String,Formula> formulaMap)
Sets the formula map, a Map of formula keys to Formulas, with the keys of the format "sheetName!formula".

Parameters:
formulaMap - A Map of formula keys to Formulas.

getCellRefMap

public java.util.Map<java.lang.String,java.util.List<CellRef>> getCellRefMap()
Returns the cell reference map, a Map of cell key strings to Lists of CellRefs. The cell key strings are original cell references, and the Lists contain translated CellRefs, e.g. "Sheet1!C2" => [C2, C3, C4]

Returns:
A Map of cell key strings to Lists of CellRefs.

setCellRefMap

public void setCellRefMap(java.util.Map<java.lang.String,java.util.List<CellRef>> cellRefMap)
Sets the cell reference map, a Map of cell key strings to Lists of CellRefs. The cell key strings are original cell references, and the Lists contain translated CellRefs, e.g. "Sheet1!C2" => [C2, C3, C4]

Parameters:
cellRefMap - A Map of cell key strings to Lists of CellRefs.

getSequenceNbr

public int getSequenceNbr()
Returns the current sequence number.

Returns:
The current sequence number.

incrSequenceNbr

public void incrSequenceNbr()
Increments the current sequence number.


getCellStyleCache

public CellStyleCache getCellStyleCache()
Returns the CellStyleCache.

Returns:
The CellStyleCache.
Since:
0.5.0

setCellStyleCache

public void setCellStyleCache(CellStyleCache cache)
Sets the CellStyleCache.

Parameters:
cache - A CellStyleCache.
Since:
0.5.0

getFontCache

public FontCache getFontCache()
Returns the FontCache.

Returns:
The FontCache.
Since:
0.5.0

setFontCache

public void setFontCache(FontCache cache)
Sets the FontCache.

Parameters:
cache - The FontCache.
Since:
0.5.0

getStyleMap

public java.util.Map<java.lang.String,Style> getStyleMap()
Returns the Map of style names to Styles.

Returns:
The Map of style names to Styles.
Since:
0.5.0

setStyleMap

public void setStyleMap(java.util.Map<java.lang.String,Style> styleMap)
Sets Map of style names to Styles.

Parameters:
styleMap - The Map of style names to Styles.
Since:
0.5.0


Copyright © 2012-2013 Jett Team. All Rights Reserved.