ag.ion.bion.officelayer.filter
Interface IFilter

All Known Implementing Classes:

AbstractFilter, BMPFilter, DataInterchangeFilter, DBaseFilter, FlashFilter, GIFFilter, HTMLFilter, JPEGFilter, MathMLFilter, MSOffice2003XMLFilter, MSOffice60Filter, MSOffice60TemplateFilter, MSOffice95Filter, MSOffice95TemplateFilter, MSOffice97Filter, MSOffice97Template, ODPresentationToDrawFilter, ODTFilter, OOPresentationToDrawFilter, OpenDocumentFilter, OpenOfficeFilter, OpenOfficeTemplateFilter, OpenTemplateFilter, PDBFilter, PDFFilter, PNGFilter, PocketOfficeFilter, PSWFilter, RTFFilter, SDW30Filter, SDW40Filter, SDW50Filter, SO30PresentationToDraw, SO50PresentationToDrawFilter, StarOffice30Filter, StarOffice30TemplateFilter, StarOffice40Filter, StarOffice40TemplateFilter, StarOffice50Filter, StarOffice50TemplateFilter, SylkFilter, TextEncFilter, TextFilter, TIFFFilter, XHTMLFilter, XMLDocBookFilter, XMLMSWORD2003Filter

public interface IFilter

Filter for the export of documents.

Field Summary

static IFilter[]

FILTERS Available default filters.

Method Summary

java.lang.String	getFileExtension(IDocument document) Returns file extension of the filter.
java.lang.String	getFileExtension(java.lang.String documentType) Returns file extension of the filter.
java.lang.String	getFilterDefinition(IDocument document) Returns definition of the filter.
java.lang.String	getName(IDocument document) Returns name of the filter.
boolean	isExternalFilter() Returns information whether the filter constructs a document which can not be interpreted again.
boolean	isSupported(IDocument document) Returns information whether the submitted document is supported by the filter.

Field Detail

FILTERS

static final IFilter[] FILTERS

Available default filters.

Method Detail

getFilterDefinition

java.lang.String getFilterDefinition(IDocument document)

Returns definition of the filter. Returns null if the filter is not available for the submitted document.

Parameters:

document - document to be exported

Returns:

definition of the filter or null if the filter is not available for the submitted document

isSupported

boolean isSupported(IDocument document)

Returns information whether the submitted document is supported by the filter.

Parameters:

document - document to be used

Returns:

information whether the submitted document is supported by the filter

isExternalFilter

boolean isExternalFilter()

Returns information whether the filter constructs a document which can not be interpreted again.

Returns:

information whether the filter constructs a document which can not be interpreted again

getFileExtension

java.lang.String getFileExtension(IDocument document)

Returns file extension of the filter. Returns null if the document is not supported by the filter.

Parameters:

document - document to be used

Returns:

file extension of the filter

getFileExtension

java.lang.String getFileExtension(java.lang.String documentType)

Returns file extension of the filter. Returns null if the document type is not supported by the filter.

Parameters:

documentType - document type to be used

Returns:

file extension of the filter

getName

java.lang.String getName(IDocument document)

Returns name of the filter. Returns null if the submitted document is not supported by the filter.

Parameters:

document - document to be used

Returns:

name of the filter