com.lf.commons.docking.filesys

Class DefaultFileHandler

java.lang.Object

com.lf.commons.docking.filesys.DefaultFileHandler

All Implemented Interfaces:

FileHandler

public class DefaultFileHandler
extends java.lang.Object
implements FileHandler

Opens files for editing/viewing using the application functionality or the operating system.

The file type definitions provided by the FileTypeUnit class are used to open/edit files. For application functionality e.g. opening a file in a form editor can be achieved by subclassing this class.

Opening/editing a file for an application means to start an appropriate (text) editor.

Since:

1.6

Version:

$Revision: 1.14 $, $Date: 2012/12/28 11:44:24 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	edittypes The priority types list for edit.
protected EditorWindow	editwindow The docking window to add new editor tabs.
protected FileTypeUnit	fileTypeUnit The options unit providing the configured files types for open/edit.
protected int[]	hexedittypes The priority types list for hex edit.
protected ApplicationModel	model The model holding the configuration.
protected int[]	opentypes The priority types list for open.
protected java.lang.String	unitID The unique ID for the FileTypeUnit.

Constructor Summary

Constructors

Constructor and Description
DefaultFileHandler() Constructor method for i18n purposes only.
DefaultFileHandler(ApplicationModel model, java.lang.String unitid, FileTypeUnit unit, EditorWindow editwindow, int[] opentypes, int[] edittypes, int[] hexedittypes) Constructor for the component.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	chooseFileOpenEdit(int appmask, java.awt.Component parent, StatusBar statusbar) Let's the user choose files to open/edit on basis of the configured file types.
boolean	chooseURLOpenEdit(int appmask, java.awt.Component parent, StatusBar statusbar) Let's the user choose network files to open/edit on basis of the configured file types.
java.io.File[]	edit(java.io.File[] files) Called if the user start editing a file.
org.apache.commons.vfs2.FileObject[]	edit(org.apache.commons.vfs2.FileObject[] urls) Called if the user start editing a network file.
javax.swing.JMenuItem[]	handle(java.io.File[] files) Called when a context menu (popup) becomes visible.
javax.swing.JMenuItem[]	handle(org.apache.commons.vfs2.FileObject[] urls) Called when a context menu (popup) becomes visible.
java.io.File[]	hexedit(java.io.File[] files) Called if the user start hex editing a file.
org.apache.commons.vfs2.FileObject[]	hexedit(org.apache.commons.vfs2.FileObject[] urls) Called if the user start hexediting a network file.
java.io.File[]	open(java.io.File[] files) Called if the user double-clicks a file.
org.apache.commons.vfs2.FileObject[]	open(org.apache.commons.vfs2.FileObject[] urls) Called if the user double-clicks a network file.

Methods inherited from class java.lang.Object

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

Field Detail

model

protected ApplicationModel model

The model holding the configuration.

unitID

protected java.lang.String unitID

The unique ID for the FileTypeUnit.

fileTypeUnit

protected FileTypeUnit fileTypeUnit

The options unit providing the configured files types for open/edit.

editwindow

protected EditorWindow editwindow

The docking window to add new editor tabs.

opentypes

protected int[] opentypes

The priority types list for open.

edittypes

protected int[] edittypes

The priority types list for edit.

hexedittypes

protected int[] hexedittypes

The priority types list for hex edit.

Constructor Detail

DefaultFileHandler

public DefaultFileHandler()
                   throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

DefaultFileHandler

public DefaultFileHandler(ApplicationModel model,
                  java.lang.String unitid,
                  FileTypeUnit unit,
                  EditorWindow editwindow,
                  int[] opentypes,
                  int[] edittypes,
                  int[] hexedittypes)

Constructor for the component.

Parameters:

model - The model holding the configuration (required)

unitid - The unique ID for the FileTypeUnit (required)

unit - The options unit (required)

editwindow - The docking window to add new editor tabs (required)

opentypes - The priority types list for open (optional)

edittypes - The priority types list for edit (optional)

hexedittypes - The priority types list for hex edit (optional)

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

Method Detail

handle

public javax.swing.JMenuItem[] handle(java.io.File[] files)

Called when a context menu (popup) becomes visible.

In order to give control to the implementations a context menu can be added or completely omitted by returning null so that context menues do not become visible at all in certain conditions.

Specified by:

handle in interface FileHandler

Parameters:

files - The files to be checked

Returns:

The menu items to be added, may be null or empty

Since:

1.6

open

public java.io.File[] open(java.io.File[] files)

Called if the user double-clicks a file.

If the file can be opened by this handler then it should open it and then return true to indicate that it has been opened. If it returns false then the other handlers can be informed in the same way (first come first serve).

Specified by:

open in interface FileHandler

Parameters:

files - The files to be opened

Returns:

The files that were opened (accepted)

Since:

1.6

edit

public java.io.File[] edit(java.io.File[] files)

Called if the user start editing a file.

If the file can be opened for editing by this handler then it should open it and then return true to indicate that it has been opened. If it returns false then the other handlers can be informed in the same way (first come first serve).

Specified by:

edit in interface FileHandler

Parameters:

files - The files to be edited

Returns:

The files that were opened (accepted)

Since:

1.6

hexedit

public java.io.File[] hexedit(java.io.File[] files)

Called if the user start hex editing a file.

If the file can be opened for editing by this handler then it should open it and then return true to indicate that it has been opened. If it returns false then the other handlers can be informed in the same way (first come first serve).

Specified by:

hexedit in interface FileHandler

Parameters:

files - The files to be hexedited

Returns:

The files that were opened (accepted)

Since:

1.6

chooseFileOpenEdit

public boolean chooseFileOpenEdit(int appmask,
                         java.awt.Component parent,
                         StatusBar statusbar)

Let's the user choose files to open/edit on basis of the configured file types.

Parameters:

appmask - Binary mask of FileTypeDef.APP_OPEN, ...

parent - The parental component (e.g. main window)

statusbar - Status bar for messages (optional)

Returns:

true if the file was opened successfully

Since:

1.6

handle

public javax.swing.JMenuItem[] handle(org.apache.commons.vfs2.FileObject[] urls)

Called when a context menu (popup) becomes visible.

In order to give control to the implementations a context menu can be added or completely omitted by returning null so that context menues do not become visible at all in certain conditions.

Specified by:

handle in interface FileHandler

Parameters:

urls - The network files to be checked

Returns:

The menu items to be added, may be null or empty

Since:

1.6

open

public org.apache.commons.vfs2.FileObject[] open(org.apache.commons.vfs2.FileObject[] urls)

Called if the user double-clicks a network file.

If the file can be opened by this handler then it should open it and then return true to indicate that it has been opened. If it returns false then the other handlers can be informed in the same way (first come first serve).

Specified by:

open in interface FileHandler

Parameters:

urls - The network files to be opened

Returns:

The network files that were opened (accepted)

Since:

1.6

edit

public org.apache.commons.vfs2.FileObject[] edit(org.apache.commons.vfs2.FileObject[] urls)

Called if the user start editing a network file.

If the file can be opened for editing by this handler then it should open it and then return true to indicate that it has been opened. If it returns false then the other handlers can be informed in the same way (first come first serve).

Specified by:

edit in interface FileHandler

Parameters:

urls - The network files to be edited

Returns:

The network files that were opened (accepted)

Since:

1.6

hexedit

public org.apache.commons.vfs2.FileObject[] hexedit(org.apache.commons.vfs2.FileObject[] urls)

Called if the user start hexediting a network file.

If the file can be opened for hexediting by this handler then it should open it and then return true to indicate that it has been opened. If it returns false then the other handlers can be informed in the same way (first come first serve).

Specified by:

hexedit in interface FileHandler

Parameters:

urls - The network files to be hexedited

Returns:

The network files that were opened (accepted)

Since:

1.6

chooseURLOpenEdit

public boolean chooseURLOpenEdit(int appmask,
                        java.awt.Component parent,
                        StatusBar statusbar)

Let's the user choose network files to open/edit on basis of the configured file types.

Parameters:

appmask - Binary mask of FileTypeDef.APP_OPEN, ...

parent - The parental component (e.g. main window)

statusbar - Status bar for messages (optional)

Returns:

true if the file was opened successfully

Since:

1.6