org.drombler.acp.core.data

Class AbstractDocumentHandler

java.lang.Object

org.drombler.acp.core.data.AbstractDataHandler<Path>

org.drombler.acp.core.data.AbstractDocumentHandler

All Implemented Interfaces:

AutoCloseable, org.drombler.commons.context.LocalContextProvider, org.drombler.commons.data.DataHandler<Path>, org.softsmithy.lib.util.UniqueKeyProvider<Path>

public abstract class AbstractDocumentHandler
extends AbstractDataHandler<Path>

An abstract Path-based DocumentHandler. It observes registered DataCapabilityProviders and adds the found data capabilities to it's local context. You can use this class as a base class for your own document handler implementations.

Author:

puce

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentHandler(String defaultFileExtenion) Creates a new instance of this class with an unkown (null) document path.
AbstractDocumentHandler(String defaultFileExtenion, Path path) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
void	close()
String	getDefaultFileExtenion() Gets the default file extension for the document type.
protected org.drombler.commons.client.dialog.FileChooserProvider	getFileChooserProvider() The system wide FileChooserProvider used for the saveNew dialog.
Path	getPath() The path of the document or null if it does not exist yet.
String	getTitle()
String	getTooltipText()
Path	getUniqueKey()
void	save() Saves the content to the file.
boolean	saveNew(String initialFileName) Saves the content to a file selected from the saveNew dialog.
protected abstract void	writeContent() Writes the content to the file.

Methods inherited from class org.drombler.acp.core.data.AbstractDataHandler

getLocalContext, isDirty, markClean, markDirty

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDocumentHandler

public AbstractDocumentHandler(String defaultFileExtenion)

Creates a new instance of this class with an unkown (null) document path.

Parameters:

defaultFileExtenion - the default file extension for the document type

AbstractDocumentHandler

public AbstractDocumentHandler(String defaultFileExtenion,
                               Path path)

Creates a new instance of this class.

Parameters:

path - the path to the document or null if unknown/ the document does not exist yet.

defaultFileExtenion - the default file extension for the document type

Method Detail

getPath

public Path getPath()

The path of the document or null if it does not exist yet.

Returns:

the path the path of the document or null if it does not exist yet

getTitle

public String getTitle()

getTooltipText

public String getTooltipText()

getDefaultFileExtenion

public String getDefaultFileExtenion()

Gets the default file extension for the document type.

Returns:

the defaultFileExtenion the default file extension for the document type

save

public void save()
          throws IOException

Saves the content to the file. Only call this method if the path is known.

Throws:

IOException

See Also:

saveNew(java.lang.String)

saveNew

public boolean saveNew(String initialFileName)
                throws IOException

Saves the content to a file selected from the saveNew dialog. If a file has been selected, the path is set to the selected file.

Parameters:

initialFileName - the initial file name

Returns:

true, if a file has been selected and saved, else false

Throws:

IOException

See Also:

save()

writeContent

protected abstract void writeContent()
                              throws IOException

Writes the content to the file.

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractDataHandler<Path>

getUniqueKey

public Path getUniqueKey()

getFileChooserProvider

protected org.drombler.commons.client.dialog.FileChooserProvider getFileChooserProvider()

The system wide FileChooserProvider used for the saveNew dialog.

Returns:

the fileChooserProvider the system wide FileChooserProvider