com.carbonfive.sstemplates
Interface SsTemplateContext

All Superinterfaces:

javax.servlet.jsp.el.FunctionMapper, javax.servlet.jsp.el.VariableResolver

All Known Implementing Classes:

SsTemplateContextImpl

public interface SsTemplateContext

extends javax.servlet.jsp.el.VariableResolver, javax.servlet.jsp.el.FunctionMapper

Method Summary

java.lang.String	addStyleData(java.lang.String name, HssfStyleData data)
org.apache.poi.hssf.usermodel.HSSFFont	createFont(java.lang.String name, short fontHeight, short color, short boldWeight, boolean italic, boolean strikeout, byte underline, short typeOffset)
java.io.File	findFileInTemplateDirectory(java.lang.String path)
short[]	getBackgroundColor()
short	getColorIndex(short[] triplet)
int	getColumnIndex()
java.lang.String	getCurrentStyle()
java.lang.Object	getCustomValue(java.lang.Object key)
int	getMaxColumnIndex()
int	getMaxRowIndex()
HssfCellAccumulator	getNamedAccumulator(java.lang.String name)
org.apache.poi.hssf.usermodel.HSSFCellStyle	getNamedStyle(java.lang.String name)
HssfStyleData	getNamedStyleData(java.lang.String name)
java.lang.Object	getPageVariable(java.lang.String key)
org.apache.poi.hssf.util.Region	getRegionForCurrentLocation()
org.apache.poi.hssf.usermodel.HSSFRow	getRow()
int	getRowIndex()
org.apache.poi.hssf.usermodel.HSSFSheet	getSheet()
org.apache.poi.hssf.usermodel.HSSFWorkbook	getWorkbook()
boolean	hasCachedStyleData(java.lang.String name)
void	incrementCellIndex()
void	incrementRowIndex()
int	nextPageBreak(int row)
java.util.Collection	parseIncludeFile(java.lang.String parsedTemplate)
void	registerMethod(java.lang.String name, java.lang.reflect.Method m)
java.lang.reflect.Method	resolveFunction(java.lang.String prefix, java.lang.String name)
java.lang.Object	resolveVariable(java.lang.String name)
void	setBackgroundColor(short[] triplet)
void	setColumnIndex(int columnIndex)
void	setCurrentStyle(java.lang.String currentStyle)
void	setCustomValue(java.lang.Object key, java.lang.Object value)
void	setPageBreaks(int firstPageBreak, int nextPageBreak)
java.lang.Object	setPageVariable(java.lang.String key, java.lang.Object value)
void	setRow(org.apache.poi.hssf.usermodel.HSSFRow row)
void	setRowIndex(int rowIndex)
void	setSheet(org.apache.poi.hssf.usermodel.HSSFSheet sheet)
void	setWorkbook(org.apache.poi.hssf.usermodel.HSSFWorkbook workbook)
void	unsetPageVariable(java.lang.String key, java.lang.Object oldValue)

Method Detail

setPageVariable

public java.lang.Object setPageVariable(java.lang.String key,
                                        java.lang.Object value)

unsetPageVariable

public void unsetPageVariable(java.lang.String key,
                              java.lang.Object oldValue)

getPageVariable

public java.lang.Object getPageVariable(java.lang.String key)

resolveVariable

public java.lang.Object resolveVariable(java.lang.String name)

Specified by:

resolveVariable in interface javax.servlet.jsp.el.VariableResolver

createFont

public org.apache.poi.hssf.usermodel.HSSFFont createFont(java.lang.String name,
                                                         short fontHeight,
                                                         short color,
                                                         short boldWeight,
                                                         boolean italic,
                                                         boolean strikeout,
                                                         byte underline,
                                                         short typeOffset)

incrementCellIndex

public void incrementCellIndex()

incrementRowIndex

public void incrementRowIndex()

getRegionForCurrentLocation

public org.apache.poi.hssf.util.Region getRegionForCurrentLocation()

addStyleData

public java.lang.String addStyleData(java.lang.String name,
                                     HssfStyleData data)

getNamedStyle

public org.apache.poi.hssf.usermodel.HSSFCellStyle getNamedStyle(java.lang.String name)
                                                          throws SsTemplateException

Throws:

SsTemplateException

getNamedStyleData

public HssfStyleData getNamedStyleData(java.lang.String name)
                                throws SsTemplateException

Throws:

SsTemplateException

hasCachedStyleData

public boolean hasCachedStyleData(java.lang.String name)

getWorkbook

public org.apache.poi.hssf.usermodel.HSSFWorkbook getWorkbook()

setWorkbook

public void setWorkbook(org.apache.poi.hssf.usermodel.HSSFWorkbook workbook)

getSheet

public org.apache.poi.hssf.usermodel.HSSFSheet getSheet()

setSheet

public void setSheet(org.apache.poi.hssf.usermodel.HSSFSheet sheet)

getRow

public org.apache.poi.hssf.usermodel.HSSFRow getRow()

setRow

public void setRow(org.apache.poi.hssf.usermodel.HSSFRow row)

getRowIndex

public int getRowIndex()

setRowIndex

public void setRowIndex(int rowIndex)

getColumnIndex

public int getColumnIndex()

setColumnIndex

public void setColumnIndex(int columnIndex)

getCurrentStyle

public java.lang.String getCurrentStyle()

setCurrentStyle

public void setCurrentStyle(java.lang.String currentStyle)

getNamedAccumulator

public HssfCellAccumulator getNamedAccumulator(java.lang.String name)

registerMethod

public void registerMethod(java.lang.String name,
                           java.lang.reflect.Method m)

resolveFunction

public java.lang.reflect.Method resolveFunction(java.lang.String prefix,
                                                java.lang.String name)

Specified by:

resolveFunction in interface javax.servlet.jsp.el.FunctionMapper

parseIncludeFile

public java.util.Collection parseIncludeFile(java.lang.String parsedTemplate)
                                      throws SsTemplateException

Throws:

SsTemplateException

findFileInTemplateDirectory

public java.io.File findFileInTemplateDirectory(java.lang.String path)

getCustomValue

public java.lang.Object getCustomValue(java.lang.Object key)

setCustomValue

public void setCustomValue(java.lang.Object key,
                           java.lang.Object value)

getColorIndex

public short getColorIndex(short[] triplet)
                    throws SsTemplateException

Throws:

SsTemplateException

setBackgroundColor

public void setBackgroundColor(short[] triplet)

getBackgroundColor

public short[] getBackgroundColor()

getMaxRowIndex

public int getMaxRowIndex()

getMaxColumnIndex

public int getMaxColumnIndex()

setPageBreaks

public void setPageBreaks(int firstPageBreak,
                          int nextPageBreak)

nextPageBreak

public int nextPageBreak(int row)