net.sf.jett.tag
Class TagContext

java.lang.Object
  net.sf.jett.tag.TagContext

public class TagContext
extends java.lang.Object

A TagContext object represents the context associated with a Tag.

Author:

Randy Gettman

Constructor Summary

TagContext()
Construct a TagContext, initializing things to null.

Method Summary

org.apache.poi.ss.usermodel.Drawing	createDrawing() Returns the Sheet's Drawing object, creating it if it doesn't exist.
java.util.Map<java.lang.String,java.lang.Object>	getBeans() Returns the Map of beans.
Block	getBlock() Returns the Block that applies to a tag.
org.apache.poi.ss.usermodel.Drawing	getDrawing() Returns the Sheet's Drawing object, if it exists yet.
java.util.Map<java.lang.String,org.apache.poi.ss.usermodel.Cell>	getProcessedCellsMap() Returns the Map of Cells that have already been processed.
org.apache.poi.ss.usermodel.Sheet	getSheet() Returns the Sheet on which a tag is found.
void	setBeans(java.util.Map<java.lang.String,java.lang.Object> beans) Sets the Map of beans.
void	setBlock(Block block) Sets the Block that applies to a tag.
void	setDrawing(org.apache.poi.ss.usermodel.Drawing drawing) Sets the Sheet's Drawing object.
void	setProcessedCellsMap(java.util.Map<java.lang.String,org.apache.poi.ss.usermodel.Cell> processedCells) Sets the Map of Cells that have already been processed.
void	setSheet(org.apache.poi.ss.usermodel.Sheet sheet) Sets the Sheet on which a tag is found.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TagContext

public TagContext()

Construct a TagContext, initializing things to null.

Method Detail

getSheet

public org.apache.poi.ss.usermodel.Sheet getSheet()

Returns the Sheet on which a tag is found.

Returns:

A Sheet.

setSheet

public void setSheet(org.apache.poi.ss.usermodel.Sheet sheet)

Sets the Sheet on which a tag is found.

Parameters:

sheet - A Sheet.

getBlock

public Block getBlock()

Returns the Block that applies to a tag.

Returns:

A Block.

setBlock

public void setBlock(Block block)

Sets the Block that applies to a tag.

Parameters:

block - A Block.

getBeans

public java.util.Map<java.lang.String,java.lang.Object> getBeans()

Returns the Map of beans.

Returns:

A Map of bean names and objects.

setBeans

public void setBeans(java.util.Map<java.lang.String,java.lang.Object> beans)

Sets the Map of beans.

Parameters:

beans - A Map of bean names and objects.

getProcessedCellsMap

public java.util.Map<java.lang.String,org.apache.poi.ss.usermodel.Cell> getProcessedCellsMap()

Returns the Map of Cells that have already been processed.

Returns:

A Map of Cells.

setProcessedCellsMap

public void setProcessedCellsMap(java.util.Map<java.lang.String,org.apache.poi.ss.usermodel.Cell> processedCells)

Sets the Map of Cells that have already been processed.

Parameters:

processedCells - A Map of Cells.

createDrawing

public org.apache.poi.ss.usermodel.Drawing createDrawing()

Returns the Sheet's Drawing object, creating it if it doesn't exist. It is hoped that this would be replaced by a call to getDrawingPatriarch in the POI "ss" package, and that that call would NOT corrupt drawings, charts, etc.

Returns:

A Drawing.

Since:

0.2.0

getDrawing

public org.apache.poi.ss.usermodel.Drawing getDrawing()

Returns the Sheet's Drawing object, if it exists yet.

Returns:

A Drawing, or null if it doesn't exist yet.

Since:

0.2.0

setDrawing

public void setDrawing(org.apache.poi.ss.usermodel.Drawing drawing)

Sets the Sheet's Drawing object. This is usually used to initialize a TagContext from another TagContext, copying the Drawing object.

Parameters:

drawing - A Drawing.

Since:

0.2.0