public class RenameForm extends OperationForm
Modifier and Type | Class and Description |
---|---|
static class |
RenameForm.CASEHANDLING
Configuration enum for handling of letter case.
|
BD_PROPERTY_NAME_SEARCH_STRING, groupReference, PROPERTY_NAME_BASEDIR
Constructor and Description |
---|
RenameForm() |
Modifier and Type | Method and Description |
---|---|
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!
|
java.util.regex.Pattern |
getPatternAsRegex()
Returns the search pattern as a regular expression object.
|
java.lang.String |
getPatternString()
Returns the search pattern as typed by the user.
|
ReplacementString |
getReplacementPattern()
Returns the replacement string as a ReplacementString object.
|
java.lang.String |
getReplacementString()
The replacement string.
|
RenameForm.CASEHANDLING |
getTreatCase()
Defines how letter case of the result name should be handled.
|
int |
hashCode()
Only the base directory is taken into account for the hash code!
|
boolean |
isExtensionOnly()
Returns true if the application shall ONLY modify the file extension
but not the file name.
|
boolean |
isIgnoreCase()
Returns true if the pattern string should be
interpreted as being not case sensitive.
|
boolean |
isPreventCaseConflict()
Returns true if the application should not allow that two file
names differ only in letter case.
|
boolean |
isProtectExtension()
Returns true if the application shall not modify the file extension.
|
boolean |
isRegexPattern()
Returns true if the pattern string should be interpreted as
a regular expression pattern.
|
void |
reset()
Resets the component.
|
void |
setExtensionOnly(boolean onlyExtension)
Set to true if the application shall ONLY modify the file extension
but not the file name.
|
void |
setIgnoreCase(boolean ignoreCase)
Set to true if the pattern string should be
interpreted as being not case sensitive.
|
void |
setPatternString(java.lang.String patternString)
Sets the raw search pattern.
|
void |
setPreventCaseConflict(boolean preventCaseConflict)
Set to true if the application should not allow that two file
names differ only in letter case.
|
void |
setProtectExtension(boolean protectExtension)
Set to true if the application shall not modify the file extension.
|
void |
setRegexPattern(boolean regexPattern)
Set to true if the pattern string should be interpreted as
a regular expression pattern.
|
void |
setReplacementString(java.lang.String replacementString)
The replacement string.
|
void |
setTreatCase(RenameForm.CASEHANDLING treatCase)
Sets how letter case of the result name should be handled.
|
void |
update(RenameForm form)
Updates this form with the data from the "form" parameter.
|
addFormUpdateListener, addPropertyChangeListener, firePropertyChangeEvent, getBaseDirectory, getGroupReference, getType, removeFormUpdateListener, removePropertyChangeListener, setBaseDirectory, setGroupReference, update
public java.util.regex.Pattern getPatternAsRegex() throws PatternException
PatternException
- if the pattern is invalidpublic boolean isIgnoreCase()
public void setIgnoreCase(boolean ignoreCase)
ignoreCase
- true if letter case should be ignoredpublic java.lang.String getPatternString()
public void setPatternString(java.lang.String patternString)
patternString
- raw search patternpublic boolean isPreventCaseConflict()
public void setPreventCaseConflict(boolean preventCaseConflict)
preventCaseConflict
- true if file names must be substantially different.public boolean isProtectExtension()
public void setProtectExtension(boolean protectExtension)
protectExtension
- true if extension must not be modifiedpublic boolean isExtensionOnly()
public void setExtensionOnly(boolean onlyExtension)
onlyExtension
- true if only the extension must be modifiedpublic boolean isRegexPattern()
public void setRegexPattern(boolean regexPattern)
regexPattern
- true for regex, false for simple pattern interpretationpublic java.lang.String getReplacementString()
public void setReplacementString(java.lang.String replacementString)
replacementString
- replacement stringpublic ReplacementString getReplacementPattern()
public RenameForm.CASEHANDLING getTreatCase()
public void setTreatCase(RenameForm.CASEHANDLING treatCase)
treatCase
- letter case of result namepublic void reset()
Resetable
public void update(RenameForm form)
form
- data to replace the content of this formpublic java.lang.Object clone()
clone
in class OperationForm
Object.clone()
public boolean equals(java.lang.Object o)
equals
in class OperationForm
public int hashCode()
hashCode
in class OperationForm