/*
#IFNDEF ALT_LICENSE
ThinWire(R) RIA Ajax Framework
Copyright (C) 2003-2007 Custom Credit Systems
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 2.1 of the License, or (at your option) any
later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along
with this library; if not, write to the Free Software Foundation, Inc., 59
Temple Place, Suite 330, Boston, MA 02111-1307 USA
Users who would rather have a commercial license, warranty or support should
contact the following company who invented, built and supports the technology:
Custom Credit Systems, Richardson, TX 75081, USA.
email: info@thinwire.com ph: +1 (888) 644-6405
http://www.thinwire.com
#ENDIF
[ v1.2_RC2 ]
*/
package thinwire.ui;
/**
* @author Joshua J. Gertzen
*/
public interface MaskEditorComponent extends EditorComponent {
public static final String PROPERTY_EDIT_MASK = "editMask";
public static final String PROPERTY_FORMAT_TEXT = "formatText";
/**
* Get this TextField's edit mask
* @return the edit mask
*/
public String getEditMask();
/**
* This method accepts an edit mask as a String and applies it to the text field.
* @param editMask
*/
public void setEditMask(String editMask);
/**
* Determines whether the text returned by getText() is formatted.
* @return true if the text is formatted, false otherwise. Default is true.
*/
public boolean isFormatText();
/**
* Sets whether the text returned by getText() is formatted.
* If an editMask is specified that contains with format charcters, such as ###,###,###.## and
* this property is set to false, then the value returned by getText will not contain the the
* commas from the editMask. i.e. If the value in the field is 123,456.78 then 123456.78 would
* be returned. Whereas, if this property is set to true then 123,456.78 would be returned.
* Another example would be with a mask of MM/dd/yyyy, value of 11/21/1978. With this set to false
* you would get the value 11211978 by calling getText(), with it set to true, you'd get 11/21/1978.
* @param formatText true if you want the text formattted, false otherwise. Default is true.
*/
public void setFormatText(boolean formatText);
}
|