org.eclipse.rse.ui.validators
Class ValidatorUserActionName

java.lang.Object
  org.eclipse.rse.ui.validators.ValidatorUniqueString
      org.eclipse.rse.ui.validators.ValidatorUserActionName

All Implemented Interfaces:

ICellEditorValidator, IInputValidator, ISystemValidator, ISystemValidatorUniqueString

public class ValidatorUserActionName

extends ValidatorUniqueString

implements ISystemValidator

This class is used to verify a user defined action's name.

Field Summary

protected boolean	fUnique
static int	MAX_UDANAME_LENGTH
protected SystemMessage	msg_Invalid
protected IWorkspace	workspace

Fields inherited from class org.eclipse.rse.ui.validators.ValidatorUniqueString

CASE_INSENSITIVE, CASE_SENSITIVE, caseSensitive, currentMessage, existingList, msg_Empty, msg_NonUnique, QUOTE, syntaxValidator, useUpperCase

Constructor Summary

ValidatorUserActionName()
Use this constructor when the name need not be unique, and you just want the syntax checking.

ValidatorUserActionName(String[] existingNameList)
Use this constructor when the name must be unique.

ValidatorUserActionName(Vector existingNameList)
Use this constructor when the name must be unique.

Method Summary

protected boolean	checkForBadCharacters(String newText) Overridable method for invalidate character check, beyond what this class offers
int	getMaximumNameLength() Return the max length for folder names: 256
SystemMessage	isSyntaxOk(String newText) Validate each character.
void	setErrorMessages(SystemMessage msg_Empty, SystemMessage msg_NonUnique, SystemMessage msg_Invalid) Supply your own error message text.
String	toString()

Methods inherited from class org.eclipse.rse.ui.validators.ValidatorUniqueString

doMessageSubstitution, getExistingNamesList, getSystemMessage, getSystemMessageText, isValid, isValid, quotedToLowerCase, setCaseSensitive, setErrorMessages, setExistingNamesList, setExistingNamesList, setUseUpperCase, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.rse.ui.validators.ISystemValidator

getSystemMessage, validate

Methods inherited from interface org.eclipse.jface.dialogs.IInputValidator

isValid

Methods inherited from interface org.eclipse.jface.viewers.ICellEditorValidator

isValid

Field Detail

MAX_UDANAME_LENGTH

public static final int MAX_UDANAME_LENGTH

See Also:

Constant Field Values

fUnique

protected boolean fUnique

msg_Invalid

protected SystemMessage msg_Invalid

workspace

protected IWorkspace workspace

Constructor Detail

ValidatorUserActionName

public ValidatorUserActionName(Vector existingNameList)

Use this constructor when the name must be unique. Give the ctor a vector containing a list of existing names to compare against.

ValidatorUserActionName

public ValidatorUserActionName(String[] existingNameList)

Use this constructor when the name must be unique. Give the ctor a string array of existing names to compare against.

ValidatorUserActionName

public ValidatorUserActionName()

Use this constructor when the name need not be unique, and you just want the syntax checking.

Method Detail

setErrorMessages

public void setErrorMessages(SystemMessage msg_Empty,
                             SystemMessage msg_NonUnique,
                             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

msg_NonUnique - error message when value entered is not unique

msg_Invalid - error message when syntax is not valid

checkForBadCharacters

protected boolean checkForBadCharacters(String newText)

Overridable method for invalidate character check, beyond what this class offers

Returns:

true if valid, false if not

toString

public String toString()

Overrides:

toString in class ValidatorUniqueString

isSyntaxOk

public SystemMessage isSyntaxOk(String newText)

Validate each character. Override of parent method. Override yourself to refine the error checking.

Overrides:

isSyntaxOk in class ValidatorUniqueString

getMaximumNameLength

public int getMaximumNameLength()

Return the max length for folder names: 256

Specified by:

getMaximumNameLength in interface ISystemValidator

Overrides:

getMaximumNameLength in class ValidatorUniqueString