Constructor and Description |
---|
FormatHandler() |
Modifier and Type | Method and Description |
---|---|
abstract void |
beginWrapDetailItem(ExportContext exportContext, Object label)
Overridable hook for format handler when we start exporting a component which is inside detail stamp.
|
FormatHandler |
clone()
Gets a copy of the FormatHandler that can handle exporting to the same format as this one does.
|
protected Object |
createExportTarget(ExportContext exportContext)
Overridable hook for format handler to create export target.
|
abstract void |
endDataElement(ExportContext exportContext)
End a data element.
|
abstract void |
endDetailStamp(ExportContext exportContext)
End a detail stamp element.
|
abstract void |
endRowElement(ExportContext exportContext)
End a row element.
|
abstract void |
endTableElement(ExportContext exportContext)
End a table element.
|
abstract void |
endTableHeaderElement(ExportContext exportContext)
End a table header element.
|
abstract void |
endWrapDetailItem(ExportContext exportContext)
Overridable hook for format handler when we end exporting a component which is inside detail stamp.
|
abstract String |
getContentType(ExportContext exportContext)
Retrieves the content type of the content this format handler generates.
|
String |
getDefaultCharset()
Gets the default charset of this export format.
|
abstract String |
getFormatType()
Retrives the export type that this format handler handles.
|
int |
getMaximumRecords(ExportContext exportContext)
Get the maximum number of rows supported by this format handler.
|
abstract void |
postContent(ExportContext exportContext)
Overridable hook for each format handler to wrap anything after we end exporting the content.
|
abstract void |
preContent(ExportContext exportContext)
Overridable hook for each format handler to inject anything before we start exporting the content of the component.
|
abstract Object |
setupExportTarget(ExportContext exportContext)
Sets up the target where the format handler dump the exported content to.
|
abstract void |
startDataElement(ExportContext exportContext)
Start a data element.
|
abstract void |
startDetailStamp(ExportContext exportContext)
Start a detail stamp element.
|
abstract void |
startRowElement(ExportContext exportContext)
Start a row element.
|
abstract void |
startTableElement(ExportContext exportContext)
Start a table element.
|
abstract void |
startTableHeaderElement(ExportContext exportContext)
Start a table header element.
|
abstract void |
writeColSpan(ExportContext exportContext, int colspan)
Handles column span attribute if it is supported.
|
abstract void |
writeRowSpan(ExportContext exportContext, int rowspan)
Handles row span attribute if it is supoorted.
|
abstract void |
writeText(ExportContext exportContext, Object text, String property)
Writes text to the export target.
|
public abstract String getFormatType()
public abstract String getContentType(ExportContext exportContext)
public FormatHandler clone()
public String getDefaultCharset()
public abstract Object setupExportTarget(ExportContext exportContext) throws IOException
IOException
public abstract void preContent(ExportContext exportContext) throws IOException
IOException
public abstract void postContent(ExportContext exportContext) throws IOException
IOException
public abstract void startTableElement(ExportContext exportContext) throws IOException
IOException
public abstract void endTableElement(ExportContext exportContext) throws IOException
IOException
public abstract void startRowElement(ExportContext exportContext) throws IOException
IOException
public abstract void endRowElement(ExportContext exportContext) throws IOException
IOException
public abstract void startTableHeaderElement(ExportContext exportContext) throws IOException
IOException
public abstract void endTableHeaderElement(ExportContext exportContext) throws IOException
IOException
public abstract void startDataElement(ExportContext exportContext) throws IOException
IOException
public abstract void endDataElement(ExportContext exportContext) throws IOException
IOException
public abstract void startDetailStamp(ExportContext exportContext) throws IOException
IOException
public abstract void endDetailStamp(ExportContext exportContext) throws IOException
IOException
public abstract void writeColSpan(ExportContext exportContext, int colspan) throws IOException
IOException
public abstract void writeRowSpan(ExportContext exportContext, int rowspan) throws IOException
IOException
public abstract void writeText(ExportContext exportContext, Object text, String property) throws IOException
text
- Text to be writtenproperty
- Name of the property of attribute (if any) of the component to be associated withIOException
public abstract void beginWrapDetailItem(ExportContext exportContext, Object label) throws IOException
IOException
public abstract void endWrapDetailItem(ExportContext exportContext) throws IOException
IOException
public int getMaximumRecords(ExportContext exportContext)
protected Object createExportTarget(ExportContext exportContext) throws IOException
IOException