com.lf.commons.gui.editor

Interface Editor

All Known Implementing Classes:

HEXEditor, ImageEditor, TextEditor, XMLEditor

public interface Editor

Configurable interface to act as model for file viewers/editors.

Since:

1.6

Version:

$Revision: 1.11 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Method Summary

Methods

Modifier and Type	Method and Description
void	addEditorListener(EditorListener listener) Installs a new editor listener.
boolean	canProcess(AbstractDataSource content) May the given data be processed by this editor?
java.awt.Component	getComponent() Provides the component visualizing the data source contents.
AbstractDataSource	getContent() Provides the displayed content.
boolean	getContentValid() Is the content of this editor OK?
SuffixFilter	getDefaultSuffixFilter() Provides the default extension filter to be presented on save/save as operations.
javax.swing.Icon	getIcon() Provides the graphical icon used for display.
java.io.InputStream	getInputStream() Provides the displayed content as binary stream e.g. to be stored.
boolean	getModified() Has the resource been edited by the user?
boolean	getReadOnly() May the resource be edited?
SuffixFilter[]	getSuffixFilters() Provides the extension filters to be presented on save/save as operations.
java.lang.String	getTitle() Provides the title used for display.
java.lang.String	getToolTip() Provides the tooltip used for display.
void	refresh() Let the editor setup its components properly.
void	removeEditorListener(EditorListener listener) Removes an editor listener.
void	resetModified() Resets the modified state.
CommonsSwingWorker	saveContent() Let the editor write pending data persistently e.g. on application exit.
CommonsSwingWorker	setContent(AbstractDataSource content, boolean load) Sets the displayed content.
void	setReadOnly(boolean enable) Resets the read-only state.
void	setStatusBar(StatusBar statusbar) Equips the component with an external status bar to be shared.
void	setSuffixFilters(SuffixFilter[] filters, SuffixFilter defaultfilter) Sets the extension filters to be presented on save/save as operations.

Method Detail

setContent

CommonsSwingWorker setContent(AbstractDataSource content,
                            boolean load)

Sets the displayed content.

Callers may wait for the worker to finish and get the status with getContentValid.

Parameters:

content - The data source

load - Load via input stream?

Returns:

The worker, may be null

Throws:

java.lang.NullPointerException - If parameter is null

java.lang.IllegalArgumentException - If parameter is invalid

Since:

1.6

getContentValid

boolean getContentValid()

Is the content of this editor OK?

Returns:

Content OK?

Since:

1.6

getContent

AbstractDataSource getContent()

Provides the displayed content.

Returns:

The content, may be null

Since:

1.6

getInputStream

java.io.InputStream getInputStream()

Provides the displayed content as binary stream e.g. to be stored.

Returns:

The stream, may be null

Since:

1.6

getComponent

java.awt.Component getComponent()

Provides the component visualizing the data source contents.

Returns:

The component

Since:

1.6

setStatusBar

void setStatusBar(StatusBar statusbar)

Equips the component with an external status bar to be shared.

If this method is called any internally installed status bar should be removed.

Parameters:

statusbar - The status bar

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

getModified

boolean getModified()

Has the resource been edited by the user?

Returns:

Modified?

Since:

1.6

resetModified

void resetModified()

Resets the modified state.

Since:

1.6

getReadOnly

boolean getReadOnly()

May the resource be edited?

Returns:

Modified?

Since:

1.6

setReadOnly

void setReadOnly(boolean enable)

Resets the read-only state.

Parameters:

enable - Read-only?

Since:

1.6

getTitle

java.lang.String getTitle()

Provides the title used for display.

Returns:

The title

Since:

1.6

getToolTip

java.lang.String getToolTip()

Provides the tooltip used for display.

Returns:

The tooltip

Since:

1.6

getIcon

javax.swing.Icon getIcon()

Provides the graphical icon used for display.

Returns:

The icon

Since:

1.6

setSuffixFilters

void setSuffixFilters(SuffixFilter[] filters,
                    SuffixFilter defaultfilter)

Sets the extension filters to be presented on save/save as operations.

Parameters:

filters - The suffix filters

defaultfilter - The default filter (optional)

Since:

1.6

getSuffixFilters

SuffixFilter[] getSuffixFilters()

Provides the extension filters to be presented on save/save as operations.

Returns:

The suffix filters

Since:

1.6

getDefaultSuffixFilter

SuffixFilter getDefaultSuffixFilter()

Provides the default extension filter to be presented on save/save as operations.

Returns:

The default filter

Since:

1.6

refresh

void refresh()

Let the editor setup its components properly.

This method is called e.g. if an editor tab becomes shown. Here, we can set the caret etc.

Since:

1.6

saveContent

CommonsSwingWorker saveContent()

Let the editor write pending data persistently e.g. on application exit.

Callers may wait for the worker to finish and get the status with getContentValid.

Returns:

The worker, may be null

Since:

1.6

canProcess

boolean canProcess(AbstractDataSource content)

May the given data be processed by this editor?

Parameters:

content - The content

Returns:

Content OK?

Since:

1.6

addEditorListener

void addEditorListener(EditorListener listener)

Installs a new editor listener.

Parameters:

listener - The listener

Since:

1.6

removeEditorListener

void removeEditorListener(EditorListener listener)

Removes an editor listener.

Parameters:

listener - The listener

Since:

1.6