Package com.rapidclipse.framework.server.reports

Class Format.Abstract

java.lang.Object

com.rapidclipse.framework.server.reports.Format.Abstract

All Implemented Interfaces:

Format

Direct Known Subclasses:

Format.Csv, Format.Docx, Format.Html, Format.Ods, Format.Odt, Format.Pdf, Format.Pptx, Format.Rtf, Format.Text, Format.Xls, Format.Xlsx, Format.Xml

Enclosing interface:

Format

public abstract static class Format.Abstract
extends Object
implements Format

Nested Class Summary

Nested classes/interfaces inherited from interface com.rapidclipse.framework.server.reports.Format

Format.Abstract, Format.Csv, Format.Docx, Format.Html, Format.Ods, Format.Odt, Format.Pdf, Format.Pptx, Format.Rtf, Format.Text, Format.Xls, Format.Xlsx, Format.Xml

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	canBePreviewedInStandardBrowser
protected boolean	hasPageMargin
protected boolean	paginationActive

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Abstract(String name, String fileSuffix, String mimeType)

Method Summary

Modifier and Type	Method	Description
void	canBePreviewedInStandardBrowser()
protected abstract DynamicExporter	createDynamicExporter()
Exporter	createExporter()
protected abstract PlainExporter	createPlainExporter()
void	disablePageMargin()
void	enablePagination()
boolean	equals(Object obj)
String	fileSuffix()
int	hashCode()
boolean	hasPageMargin()	Returns if a report has a page margin.
boolean	isPaginationActive()	Returns if a report is paginated (on every new page a new title, column-headers are printed, etc)
boolean	isPreviewableInStandardBrowser()	Returns if a preview can be shown in a "standardized" browser (e.g.
String	mimeType()
String	name()
void	setHasPageMargin(boolean hasPageMargin)
void	setPaginationActive(boolean paginationActive)
void	setPreviewableInStandardBrowser(boolean canBePreviewedInStandardBrowser)

Methods inherited from class java.lang.Object

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

Field Detail

canBePreviewedInStandardBrowser

protected boolean canBePreviewedInStandardBrowser

paginationActive

protected boolean paginationActive

hasPageMargin

protected boolean hasPageMargin

Constructor Detail

Abstract

protected Abstract(String name,
                   String fileSuffix,
                   String mimeType)

Method Detail

canBePreviewedInStandardBrowser

public void canBePreviewedInStandardBrowser()

setPreviewableInStandardBrowser

public void setPreviewableInStandardBrowser(boolean canBePreviewedInStandardBrowser)

enablePagination

public void enablePagination()

setPaginationActive

public void setPaginationActive(boolean paginationActive)

disablePageMargin

public void disablePageMargin()

setHasPageMargin

public void setHasPageMargin(boolean hasPageMargin)

name

public String name()

Specified by:

name in interface Format

fileSuffix

public String fileSuffix()

Specified by:

fileSuffix in interface Format

mimeType

public String mimeType()

Specified by:

mimeType in interface Format

isPreviewableInStandardBrowser

public boolean isPreviewableInStandardBrowser()

Description copied from interface: Format

Returns if a preview can be shown in a "standardized" browser (e.g. the latest versions of Chrome and Firefox)

Specified by:

isPreviewableInStandardBrowser in interface Format

Returns:

true if a preview can be shown in the browser

isPaginationActive

public boolean isPaginationActive()

Description copied from interface: Format

Returns if a report is paginated (on every new page a new title, column-headers are printed, etc)

Specified by:

isPaginationActive in interface Format

Returns:

true if the pagination is active

hasPageMargin

public boolean hasPageMargin()

Description copied from interface: Format

Returns if a report has a page margin.

Specified by:

hasPageMargin in interface Format

Returns:

true if there is a page margin

createExporter

public Exporter createExporter()

Specified by:

createExporter in interface Format

createDynamicExporter

protected abstract DynamicExporter createDynamicExporter()

createPlainExporter

protected abstract PlainExporter createPlainExporter()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object