|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.pietschy.command.Command
com.pietschy.command.ActionCommand
com.pietschy.command.file.AbstractFileCommand
public abstract class AbstractFileCommand
Base implementation of file commands. It provides the common JFileChooser
functionality. Subclasses must override showChooserDialog(javax.swing.JFileChooser, java.awt.Component) and performFileAction(java.io.File[], javax.swing.JFileChooser, java.awt.Component)
to provide appropriate functionality.
| Field Summary |
|---|
| Fields inherited from class com.pietschy.command.ActionCommand |
|---|
PARAMETER_ACTION_EVENT, PARAMETER_INVOKER, PARAMETER_INVOKER_WINDOW, PARAMETER_MODIFIERS |
| Fields inherited from class com.pietschy.command.Command |
|---|
internalLog, PROPERTY_ENABLED, PROPERTY_VISIBLE |
| Constructor Summary | |
|---|---|
AbstractFileCommand(javax.swing.filechooser.FileFilter[] filters)
Creates a new anonymous AbstractFileCommand with the specified file filters. |
|
AbstractFileCommand(java.lang.String id,
javax.swing.filechooser.FileFilter[] filters)
Creates a new instance with the specified id and file filters. |
|
| Method Summary | |
|---|---|
protected boolean |
beforeProceeding(java.awt.Component centerOn)
This is method can be overridden to prevent the action from proceeding. |
protected java.awt.Component |
getComponentToCenterOn()
Provides the component on which to center the chooser. |
javax.swing.filechooser.FileFilter |
getDefaultFileFilter()
Gets the default FileFilter that will be selected in the chooser if
isRememberLastFilter() is false. |
protected void |
handleCancel(javax.swing.JFileChooser chooser,
java.awt.Component centerOn)
This method is invoked if the user cancels the file chooser dialog. |
protected void |
handleError(javax.swing.JFileChooser chooser,
java.awt.Component centerOn)
This method is invoked if the showChooserDialog(javax.swing.JFileChooser, java.awt.Component) returns
JFileChooser.ERROR_OPTION. |
protected void |
handleExecute()
Main entry point for command subclasses that must be implemented to provide command specific behaviour. |
boolean |
isAcceptAllFileFilterUsed()
Used to configure JFileChooser.setAcceptAllFileFilterUsed(boolean). |
boolean |
isRememberLastFilter()
Checks if the last FileFilter used by the user will be remembered. |
protected abstract void |
performFileAction(java.io.File[] files,
javax.swing.JFileChooser chooser,
java.awt.Component centerOn)
This method is invoked if the showChooserDialog(javax.swing.JFileChooser, java.awt.Component) returns
JFileChooser.APPROVE_OPTION. |
protected javax.swing.JFileChooser |
prepareFileChooser()
Gets the file choose the command will use. |
void |
setAcceptAllFileFilterUsed(boolean accept)
Used to configure JFileChooser.setAcceptAllFileFilterUsed(boolean). |
void |
setDefaultFileFilter(javax.swing.filechooser.FileFilter defaultFileFilter)
Sets the default FileFilter that will be selected in the chooser if
isRememberLastFilter() is false. |
void |
setRememberLastFilter(boolean rememberLastFilter)
Configures this command to remember the FileFilter last used by the user. |
void |
setSelectedFile(java.io.File file)
Sets the file to be selected when the chooser is displayed. |
void |
setSelectedFiles(java.io.File[] files)
Sets the files to be selected when the chooser is displayed. |
protected abstract int |
showChooserDialog(javax.swing.JFileChooser chooser,
java.awt.Component centerOn)
Called to display the JFileChooser. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.pietschy.command.ActionCommandExecutor |
|---|
addPropertyChangeListener, addPropertyChangeListener, isEnabled, removePropertyChangeListener, removePropertyChangeListener |
| Methods inherited from interface com.pietschy.command.Identifiable |
|---|
getId |
| Constructor Detail |
|---|
public AbstractFileCommand(javax.swing.filechooser.FileFilter[] filters)
setAcceptAllFileFilterUsed(boolean)
will be set to true
filters - the file filters to use.
java.lang.NullPointerException - if filters is null
public AbstractFileCommand(java.lang.String id,
javax.swing.filechooser.FileFilter[] filters)
setAcceptAllFileFilterUsed(boolean) will be set to true.
filters - the file filters to use.
java.lang.NullPointerException - if filters is null| Method Detail |
|---|
protected void handleExecute()
ActionCommand
This method should never be called directly to invoke a command. All
command invocation must be performed using the ActionCommand.execute() and
ActionCommand.execute(Map) methods.
handleExecute in class ActionCommandprotected java.awt.Component getComponentToCenterOn()
ActionCommand.getInvokerWindow().
protected void handleCancel(javax.swing.JFileChooser chooser,
java.awt.Component centerOn)
chooser - the chooser that was cancelled.centerOn - protected boolean beforeProceeding(java.awt.Component centerOn)
true .
centerOn - the component that the chooser will be centered on.
true to preceed with showing the chooser, false to cancel the
action. The default implementation always returns true.
protected void handleError(javax.swing.JFileChooser chooser,
java.awt.Component centerOn)
showChooserDialog(javax.swing.JFileChooser, java.awt.Component) returns
JFileChooser.ERROR_OPTION. The default implementation does nothing, subclasses
can override to handle the error.
chooser - the JFileChooser that was displayed.centerOn -
protected abstract int showChooserDialog(javax.swing.JFileChooser chooser,
java.awt.Component centerOn)
JFileChooser. Subclasses override to display an appropriate
version of the chooser (such as an open or save dialog). This method must return the result
of the JFileChooser show method. Eg.
protected int showChooserDialog(JFileChooser chooser, Window invoker)
{
return chooser.showOpenDialog(invoker);
}
chooser - the chooser to display
JFileChooser.showDialog(java.awt.Component, java.lang.String), JFileChooser.showOpenDialog(java.awt.Component) or
JFileChooser.showSaveDialog(java.awt.Component).
protected abstract void performFileAction(java.io.File[] files,
javax.swing.JFileChooser chooser,
java.awt.Component centerOn)
showChooserDialog(javax.swing.JFileChooser, java.awt.Component) returns
JFileChooser.APPROVE_OPTION. Subclasses must override to perform the specific file
operation.
files - the files that were selected in the JFileChooserchooser - the JFileChooser that was displayed.centerOn - the component to center the chooser on.protected javax.swing.JFileChooser prepareFileChooser()
JFileChooser.public void setSelectedFile(java.io.File file)
file - the file to be selected when the chooser is displayed.public void setSelectedFiles(java.io.File[] files)
files - the files to be selected when the chooser is displayed.public javax.swing.filechooser.FileFilter getDefaultFileFilter()
FileFilter that will be selected in the chooser if
isRememberLastFilter() is false.
If not explicitly specified, this value will be the filter specified in the constructor, or
the first filter if a list of filteres was specified.
public void setDefaultFileFilter(javax.swing.filechooser.FileFilter defaultFileFilter)
FileFilter that will be selected in the chooser if
isRememberLastFilter() is false.
If not explicitly specified, this value will be the filter specified in the constructor, or
the first filter if a list of filteres was specified.
defaultFileFilter - the default file filter.public boolean isRememberLastFilter()
FileFilter used by the user will be remembered.
FileFilter used by the
user, false if default is always used.public void setRememberLastFilter(boolean rememberLastFilter)
FileFilter last used by the user. This
property defaults to false.
rememberLastFilter - true to remember the last FileFilter used,
false to always used the default FileFilter.public boolean isAcceptAllFileFilterUsed()
JFileChooser.setAcceptAllFileFilterUsed(boolean).
public void setAcceptAllFileFilterUsed(boolean accept)
JFileChooser.setAcceptAllFileFilterUsed(boolean).
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||