net.pandoragames.far.ui.model

Class OperationForm

java.lang.Object

net.pandoragames.far.ui.model.OperationForm

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Resetable

Direct Known Subclasses:

FARForm, RenameForm

public abstract class OperationForm
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, Resetable

Common base class for FAR data models. Each tab of the FAR GUI is backed by a specialized form class. The form receives data from the UI and serves as "protocol" for the backend.

Author:

Olivier Wehner

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BD_PROPERTY_NAME_SEARCH_STRING Used for PropertyChangeListener.
protected char	groupReference The group reference indicator used in replacement strings.
protected static java.lang.String	PROPERTY_NAME_BASEDIR Used for PropertyChangeListener.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OperationForm(OperationType operation)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFormUpdateListener(FormUpdateListener listener) Adds a Listener that will be informed whenever this form is updated through method update().
protected void	addPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Adds a PropertyChangeListener.
java.lang.Object	clone() Returns a copy of this object.
boolean	equals(java.lang.Object o) Only the base directory is taken into account for equals!
protected void	firePropertyChangeEvent(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) Fires a PropertyChageEvent if interested Listener are registered.
java.io.File	getBaseDirectory() Returns the base directory.
char	getGroupReference() Returns the group reference indicator used in replacement strings.
OperationType	getType() Returns the type of this form.
int	hashCode() Only the base directory is taken into account for the hash code!
void	removeFormUpdateListener(FormUpdateListener listener) Removes a previously registered update listener.
protected void	removePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Removes a PropertyChangeListener.
void	setBaseDirectory(java.io.File baseDirectory) Sets the base directory.
void	setGroupReference(char groupReferenceIndicator) Sets the group reference indicator used in replacement strings.
protected void	update(OperationForm form) Updates this form with the data from the "form" parameter.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.pandoragames.far.ui.model.Resetable

reset

Field Detail

PROPERTY_NAME_BASEDIR

protected static final java.lang.String PROPERTY_NAME_BASEDIR

Used for PropertyChangeListener.

See Also:

Constant Field Values

BD_PROPERTY_NAME_SEARCH_STRING

protected static final java.lang.String BD_PROPERTY_NAME_SEARCH_STRING

Used for PropertyChangeListener.

See Also:

Constant Field Values

groupReference

protected char groupReference

The group reference indicator used in replacement strings. This class uses the backslash ('\') as default.

Constructor Detail

OperationForm

protected OperationForm(OperationType operation)

Method Detail

getType

public OperationType getType()

Returns the type of this form. This is a convinience form of the instanceof operator, suitable for switch-case.

Returns:

type of form, one of the constants of this class

getBaseDirectory

public java.io.File getBaseDirectory()

Returns the base directory. The base directory is used for the construction of search and backup trees.

Returns:

base directory for file operations

See Also:

FileMatcher.getBaseDirectory()

setBaseDirectory

public void setBaseDirectory(java.io.File baseDirectory)

Sets the base directory. The base directory is used for the construction of search and backup trees.

Parameters:

baseDirectory - base directory for file operations

See Also:

FileMatcher.getBaseDirectory()

getGroupReference

public char getGroupReference()

Returns the group reference indicator used in replacement strings. This class uses the backslash ('\') as default.

Returns:

group reference indicator

See Also:

ReplacementString

setGroupReference

public void setGroupReference(char groupReferenceIndicator)

Sets the group reference indicator used in replacement strings.

Parameters:

groupReferenceIndicator - group reference indicator

See Also:

ReplacementString

update

protected void update(OperationForm form)

Updates this form with the data from the "form" parameter. Inheriting classes must take care to call this method after they have performed the update.

Parameters:

form - data to replace the content of this form

addPropertyChangeListener

protected void addPropertyChangeListener(java.lang.String property,
                             java.beans.PropertyChangeListener listener)

Adds a PropertyChangeListener. This method may be made public by inheriting classes.

Parameters:

property - name of the property the Listener is registered for.

listener - the listener to register.

removePropertyChangeListener

protected void removePropertyChangeListener(java.lang.String property,
                                java.beans.PropertyChangeListener listener)

Removes a PropertyChangeListener. This method may be made public by inheriting classes.

Parameters:

property - name of the property the Listener is registered for.

listener - the listener to remove.

firePropertyChangeEvent

protected void firePropertyChangeEvent(java.lang.String propertyName,
                           java.lang.Object oldValue,
                           java.lang.Object newValue)

Fires a PropertyChageEvent if interested Listener are registered.

Parameters:

propertyName - name of the changed Property

oldValue - old property value

newValue - new property value

addFormUpdateListener

public void addFormUpdateListener(FormUpdateListener listener)

Adds a Listener that will be informed whenever this form is updated through method update(). The listener will be called after the fields of this form have been updated.

Parameters:

listener - to be informed whenever this form is updated.

removeFormUpdateListener

public void removeFormUpdateListener(FormUpdateListener listener)

Removes a previously registered update listener.

Parameters:

listener - to be removed

clone

public java.lang.Object clone()

Returns a copy of this object.

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

equals

public boolean equals(java.lang.Object o)

Only the base directory is taken into account for equals!

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Only the base directory is taken into account for the hash code!

Overrides:

hashCode in class java.lang.Object