org.drombler.acp.core.data

Annotation Type DocumentHandler

@Documented
 @Retention(value=SOURCE)
 @Target(value=TYPE)
public @interface DocumentHandler

Registers a document handler. A document handler usually knows how to read, save etc. a particular kind of document. A document handler is usally Path based. To fully integrate with the framework it should implement LocalContextProvider, observe registered DataCapabilityProviders and add the found data capabilities to it's local context. The easiest way to implement a document handler is to extend AbstractDocumentHandler, but it's not required.

Author:

puce

See Also:

AbstractDocumentHandler

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	mimeType The MIME type of the document.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	icon The icon name pattern to resolve the icons to be used for this file type handler.

Element Detail

mimeType

public abstract String mimeType

The MIME type of the document.

Returns:

the MIME type of the document

icon

public abstract String icon

The icon name pattern to resolve the icons to be used for this file type handler. Note that this only specifies the name pattern. Drombler ACP looks for <icon-base-name>16.<icon-extension> for data types (expected to be 16x16 pixels). So if icon is "test.png", Drombler ACP would look for test16.png.

Returns:

the icon name pattern

Default:

""