net.pandoragames.far.ui.model

Class ReplaceForm

java.lang.Object

net.pandoragames.far.ui.model.OperationForm

net.pandoragames.far.ui.model.FARForm

net.pandoragames.far.ui.model.ReplaceForm

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, ContentFilter, Resetable, ReplacementDescriptor

public class ReplaceForm
extends FARForm
implements ReplacementDescriptor, java.beans.PropertyChangeListener

Defines the parameter for a replace operation. This form is supposed to be coupled to a FindForm by means of its quality as PropertyChangeListener.

Author:

Olivier Wehner

See Also:

Serialized Form

Field Summary

Fields inherited from class net.pandoragames.far.ui.model.FARForm

LB_REGEX, regexPattern

Fields inherited from class net.pandoragames.far.ui.model.OperationForm

BD_PROPERTY_NAME_SEARCH_STRING, groupReference, PROPERTY_NAME_BASEDIR

Constructor Summary

Constructors

Constructor and Description
ReplaceForm() Constructor for a ReplaceForm.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBackUpDirectoryPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a PropertyChangeListener for the backUpDirectory property.
void	addDoBackPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a PropertyChangeListener for the doBackup property.
ReplaceForm	clone() Returns a copy of this object.
boolean	equals(java.lang.Object o) Only the base directory is taken into account for equals!
java.io.File	getBackupDirectory() Returns the backup directory.
ReplacementString	getReplacementPattern(java.lang.String lineBreak) Returns the replacement string as a ReplacementString object.
java.lang.String	getReplacementString() Returns the raw replacement string as specified by the user.
int	hashCode() Only the base directory is taken into account for the hash code!
boolean	isDoBackup() Returns the doBackup flag.
void	propertyChange(java.beans.PropertyChangeEvent evt) Listens to changes of the baseDirectory property value.
void	reset() Sets search and replacement string both to the empty string.
void	setBackupDirectory(java.io.File backUpdDirectory) Sets the backup directory.
void	setDoBackup(boolean doBackup) Sets the doBackup flag.
void	setGroupReference(char groupReferenceIndicator) Sets the group reference indicator used in replacement strings.
void	setReplacementString(java.lang.String replacement) Sets the string that will be used to replace parts of file content.
void	update(ReplaceForm form) Updates this form with the data from the "form" parameter.

Methods inherited from class net.pandoragames.far.ui.model.FARForm

getContentPatternAsRegex, getSearchStringContent, isIgnoreCase, isRegexContentPattern, setIgnoreCase, setRegexContentPattern, setSearchStringContent, update

Methods inherited from class net.pandoragames.far.ui.model.OperationForm

addFormUpdateListener, addPropertyChangeListener, firePropertyChangeEvent, getBaseDirectory, getGroupReference, getType, removeFormUpdateListener, removePropertyChangeListener, setBaseDirectory, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.pandoragames.far.ui.ReplacementDescriptor

getBaseDirectory

Methods inherited from interface net.pandoragames.far.ui.ContentFilter

getContentPatternAsRegex, getSearchStringContent

Constructor Detail

ReplaceForm

public ReplaceForm()

Constructor for a ReplaceForm.

Method Detail

getReplacementPattern

public ReplacementString getReplacementPattern(java.lang.String lineBreak)

Returns the replacement string as a ReplacementString object.

Specified by:

getReplacementPattern in interface ReplacementDescriptor

Parameters:

lineBreak - the lineBreak to be used, if null the system dependent line separator will be used

Returns:

ReplacementString object or null if no replacement is defined.

getBackupDirectory

public java.io.File getBackupDirectory()

Returns the backup directory.

Specified by:

getBackupDirectory in interface ReplacementDescriptor

Returns:

backup directory if any

See Also:

FileMatcher.setBackUpDirectory(File)

setBackupDirectory

public void setBackupDirectory(java.io.File backUpdDirectory)

Sets the backup directory.

Parameters:

backUpdDirectory - where to write backups to

See Also:

FileMatcher.setBackUpDirectory(File)

isDoBackup

public boolean isDoBackup()

Returns the doBackup flag. Note that the application may choose to create temporary backups, even if this flag is set to false, in order to allow undo operations.

Specified by:

isDoBackup in interface ReplacementDescriptor

Returns:

whether backups should be created or not

See Also:

FileMatcher.isDoBackup()

setDoBackup

public void setDoBackup(boolean doBackup)

Sets the doBackup flag. Note that the application may choose to create temporary backups, even if this flag is set to false, in order to allow undo operations.

Parameters:

doBackup - whether backups should be created or not

See Also:

FileMatcher.isDoBackup()

getReplacementString

public java.lang.String getReplacementString()

Returns the raw replacement string as specified by the user.

Specified by:

getReplacementString in interface ReplacementDescriptor

Returns:

replacement string, possibly empty, never null

setReplacementString

public void setReplacementString(java.lang.String replacement)

Sets the string that will be used to replace parts of file content. If the parameter is null, the replacement string will be reset.

Parameters:

replacement - replacement string

setGroupReference

public void setGroupReference(char groupReferenceIndicator)

Sets the group reference indicator used in replacement strings.

Overrides:

setGroupReference in class OperationForm

Parameters:

groupReferenceIndicator - group reference indicator

See Also:

ReplacementString

update

public void update(ReplaceForm 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

addBackUpDirectoryPropertyChangeListener

public void addBackUpDirectoryPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a PropertyChangeListener for the backUpDirectory property.

Parameters:

listener - to be added

addDoBackPropertyChangeListener

public void addDoBackPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a PropertyChangeListener for the doBackup property.

Parameters:

listener - to be added

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Listens to changes of the baseDirectory property value.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

evt - property change event

reset

public void reset()

Sets search and replacement string both to the empty string.

Specified by:

reset in interface Resetable

Overrides:

reset in class FARForm

clone

public ReplaceForm clone()

Returns a copy of this object.

Specified by:

clone in interface ContentFilter

Specified by:

clone in interface ReplacementDescriptor

Overrides:

clone in class OperationForm

Returns:

copy of this 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 FARForm

hashCode

public int hashCode()

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

Overrides:

hashCode in class FARForm