org.eclipse.rse.ui.validators
Class ValidatorSpecialChar
java.lang.Object
org.eclipse.rse.ui.validators.ValidatorSpecialChar
-
All Implemented Interfaces:
-
IInputValidator,
ICellEditorValidator,
ISystemValidator
-
Direct Known Subclasses:
-
ValidatorUserId
-
public class ValidatorSpecialChar
- extends
Object
- implements
ISystemValidator
This class is used in dialogs that prompt for string, where the
string is not allowed to content special characters, as supplied to this class.
The IInputValidator interface is used by jface's
InputDialog class and numerous other platform and system classes.
|
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
EMPTY_ALLOWED_NO
public static final boolean EMPTY_ALLOWED_NO
-
See Also:
-
Constant Field Values
EMPTY_ALLOWED_YES
public static final boolean EMPTY_ALLOWED_YES
-
See Also:
-
Constant Field Values
specialChars
protected
StringBuffer specialChars
msg_Invalid
protected
SystemMessage msg_Invalid
msg_Empty
protected
SystemMessage msg_Empty
currentMessage
protected
SystemMessage currentMessage
ValidatorSpecialChar
public ValidatorSpecialChar(
String specialChars,
boolean isEmptyAllowed)
- Constructor
-
Parameters:
-
specialChars - String containing special characters to test for. -
isEmptyAllowed - true if an empty string is valid
ValidatorSpecialChar
public ValidatorSpecialChar(
String specialChars,
boolean isEmptyAllowed,
SystemMessage msg_Invalid)
- Constructor
-
Parameters:
-
specialChars - String containing special characters to test for. -
isEmptyAllowed - true if an empty string is valid -
msg_Invalid - error message when invalid characters entered
ValidatorSpecialChar
public ValidatorSpecialChar(
String specialChars,
boolean isEmptyAllowed,
SystemMessage msg_Invalid,
SystemMessage msg_Empty)
- Constructor
-
Parameters:
-
specialChars - String containing special characters to test for. -
isEmptyAllowed - true if an empty string is valid -
msg_Invalid - error message when invalid characters entered -
msg_Empty - error message when empty string
setErrorMessages
public void setErrorMessages(
SystemMessage msg_Empty,
SystemMessage msg_Invalid)
- Supply your own error message text. By default, messages from RSEUIPlugin resource bundle are used.
-
-
-
Parameters:
-
msg_Empty - error message when entry field is empty or null if to keep the default -
msg_Invalid - error message when value entered is not valid, or null if to keep the default
doMessageSubstitution
protected
String doMessageSubstitution(
SystemMessage msg,
String substitution)
- Helper method to substitute data into a message
-
-
getSystemMessageText
protected
String getSystemMessageText(
SystemMessage msg)
- Helper method to set the current system message and return its level one text
-
-
isValid
public
String isValid(
String newText)
- Validate each character.
-
-
Specified by:
-
isValid
in interface
IInputValidator
-
isValid
public
String isValid(
Object newValue)
- As required by ICellEditor
-
-
Specified by:
-
isValid
in interface
ICellEditorValidator
-
containsSpecialCharacters
protected boolean containsSpecialCharacters(
String newText)
-
-
isSyntaxOk
public
SystemMessage isSyntaxOk(
String newText)
- Override in child to do your own syntax checking.
-
-
getMaximumNameLength
public int getMaximumNameLength()
- Return the max length for this name, or -1 if no max
-
-
Specified by:
-
getMaximumNameLength
in interface
ISystemValidator
-
getSystemMessage
public
SystemMessage getSystemMessage()
- When isValid returns non-null, call this to get the SystemMessage object for the error
versus the simple string message.
-
-
Specified by:
-
getSystemMessage
in interface
ISystemValidator
-
validate
public
SystemMessage validate(
String text)
- For convenience, this is a shortcut to calling:
if (isValid(text) != null)
msg = getSystemMessage();
-
-
Specified by:
-
validate
in interface
ISystemValidator
-
Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.
