com.lf.commons.docking.filesys

Interface FileHandler

All Known Implementing Classes:

DefaultFileHandler

public interface FileHandler

Interface for handlers for showing additional items in the context menus of the tree and table.

Besides the default functions applicable to files and directories applications may want to add specialized functionalities like generating a message digest file or so. Additionally the implementations provide a mechanims to open files in an application specific way. If the user double-clicks a file it may open specialized dialogs or applications.

Since:

1.6

Version:

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

Author:

Axel Schwolow

Method Summary

Methods

Modifier and Type	Method and Description
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 hexediting 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.

Method Detail

handle

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.

Parameters:

files - The files to be checked

Returns:

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

Since:

1.6

open

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).

Parameters:

files - The files to be opened

Returns:

The files that were opened (accepted)

Since:

1.6

edit

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).

Parameters:

files - The files to be edited

Returns:

The files that were opened (accepted)

Since:

1.6

hexedit

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

Called if the user start hexediting a 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).

Parameters:

files - The files to be hexedited

Returns:

The files that were opened (accepted)

Since:

1.6

handle

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.

Parameters:

urls - The network files to be checked

Returns:

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

Since:

1.6

open

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).

Parameters:

urls - The network files to be opened

Returns:

The network files that were opened (accepted)

Since:

1.6

edit

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).

Parameters:

urls - The network files to be edited

Returns:

The network files that were opened (accepted)

Since:

1.6

hexedit

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).

Parameters:

urls - The network files to be hexedited

Returns:

The network files that were opened (accepted)

Since:

1.6