Wt::WIntValidator Class Reference

A validator that validates integer user input. More...

#include <Wt/WIntValidator>

Inheritance diagram for Wt::WIntValidator:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 WIntValidator (WObject *parent=0)
 Create a new integer validator that accepts any integer.
 WIntValidator (int minimum, int maximum, WObject *parent=0)
 Create a new integer validator that accepts integer input within the given range.
int bottom () const
 Return the bottom of the valid integer range.
void setBottom (int bottom)
 Set the bottom of the valid integer range.
int top () const
 Return the top of the valid integer range.
void setTop (int top)
 Set the top of the valid integer range.
virtual void setRange (int bottom, int top)
 Set the range of valid integers.
virtual State validate (WString &input, int &pos) const
 Validate the given input.
virtual void createExtConfig (std::ostream &config) const
 Provide Ext-compatible config options for client-side validation.
void setInvalidNotANumberText (const WString &text)
 Set the message to display when the input is not a number.
WString invalidNotANumberText () const
 Returns the message displayed when the input is not a number.
void setInvalidTooSmallText (const WString &text)
 Set message to display when the number is too small.
WString invalidTooSmallText () const
 Returns the message displayed when the number is too small.
void setInvalidTooLargeText (const WString &text)
 Set message to display when the number is too large.
WString invalidTooLargeText () const
 Returns the message displayed when the number is too large.

Protected Member Functions

std::string javaScriptValidate (const std::string &jsRef) const
 Creates a Javascript expression that validates the input.
std::string inputFilter () const
 Returns a regular expression that filters input.


Detailed Description

A validator that validates integer user input.

This validator checks whether user input is an integer number in a pre-defined range.


Member Function Documentation

void Wt::WIntValidator::setBottom ( int  bottom  ) 

Set the bottom of the valid integer range.

The default value is std::numeric_limits<int>::min().

void Wt::WIntValidator::setTop ( int  top  ) 

Set the top of the valid integer range.

The default value is std::numeric_limits<int>::max().

WValidator::State Wt::WIntValidator::validate ( WString input,
int &  pos 
) const [virtual]

Validate the given input.

The input is considered valid only when it is blank for a non-mandatory field, or represents an integer within the valid range.

Reimplemented from Wt::WValidator.

void Wt::WIntValidator::setInvalidNotANumberText ( const WString text  ) 

Set the message to display when the input is not a number.

The default value is "Must be an integer number."

WString Wt::WIntValidator::invalidNotANumberText (  )  const

Returns the message displayed when the input is not a number.

See also:
setInvalidNotANumberText(const WString&)

void Wt::WIntValidator::setInvalidTooSmallText ( const WString text  ) 

Set message to display when the number is too small.

Depending on whether bottom() and top() are real bounds, the default message is "The number must be between {1} and {2}" or "The number must be larger than {1}".

WString Wt::WIntValidator::invalidTooSmallText (  )  const

Returns the message displayed when the number is too small.

See also:
setInvalidTooSmallText(const WString&)

void Wt::WIntValidator::setInvalidTooLargeText ( const WString text  ) 

Set message to display when the number is too large.

Depending on whether bottom() and top() are real bounds, the default message is "The number must be between {1} and {2}" or "The number must be smaller than {2}".

WString Wt::WIntValidator::invalidTooLargeText (  )  const

Returns the message displayed when the number is too large.

See also:
setInvalidTooLargeText(const WString&)

std::string Wt::WIntValidator::javaScriptValidate ( const std::string &  jsRef  )  const [protected, virtual]

Creates a Javascript expression that validates the input.

The JavaScript expression should evaluate to an object with two fields: a boolean valid, and a message that indicates the problem if not valid.

Return an empty string if you are not provide the client-side validation.

See also:
inputFilter()

Reimplemented from Wt::WValidator.

std::string Wt::WIntValidator::inputFilter (  )  const [protected, virtual]

Returns a regular expression that filters input.

The returned regular expression is used to filter keys presses. The regular expression should accept valid single characters.

For details on valid regular expressions, see WRegExpValidator. As an example, "[0-9]" would only accept numbers as valid input.

The default implementation returns an empty string, which does not filter any input.

See also:
javaScriptValidate()

Reimplemented from Wt::WValidator.


Generated on Fri Sep 12 17:01:14 2008 for Wt by doxygen 1.5.6