atom.widget.EditText Maven / Gradle / Ivy
/*
* Copyright © 2014 Geeoz, and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Research Projects is dual-licensed under the GNU General Public
* License, version 2.0 (GPLv2) and the Geeoz Commercial License.
*
* Solely for non-commercial purposes. A purpose is non-commercial only if
* it is in no manner primarily intended for or directed toward commercial
* advantage or private monetary compensation.
*
* This Geeoz Software is supplied to you by Geeoz in consideration of your
* agreement to the following terms, and your use, installation, modification
* or redistribution of this Geeoz Software constitutes acceptance of these
* terms. If you do not agree with these terms, please do not use, install,
* modify or redistribute this Geeoz Software.
*
* Neither the name, trademarks, service marks or logos of Geeoz may be used
* to endorse or promote products derived from the Geeoz Software without
* specific prior written permission from Geeoz.
*
* The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
* COMBINATION WITH YOUR PRODUCTS.
*
* IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
* AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
* THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
* OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* A copy of the GNU General Public License is included in the distribution in
* the file LICENSE and at
*
* http://www.gnu.org/licenses/gpl-2.0.html
*
* If you are using the Research Projects for commercial purposes, we
* encourage you to visit
*
* http://products.geeoz.com/license
*
* for more details.
*
* This software or hardware and documentation may provide access to
* or information on content, products, and services from third parties.
* Geeoz and its affiliates are not responsible for and expressly disclaim
* all warranties of any kind with respect to third-party content, products,
* and services. Geeoz and its affiliates will not be responsible for any loss,
* costs, or damages incurred due to your access to or use of third-party
* content, products, or services. If a third-party content exists, the
* additional copyright notices and license terms applicable to portions of the
* software are set forth in the THIRD_PARTY_LICENSE_README file.
*
* Please contact Geeoz or visit www.geeoz.com if you need additional
* information or have any questions.
*/
package atom.widget;
import atom.view.AbstractView;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import java.util.Objects;
/**
* EditText is a thin veneer over TextView that configures itself to be
* editable.
*
* @author Alex Voloshyn
* @version 1.2 4/20/14
*/
@XmlType(namespace = AbstractView.LAYOUT_NAMESPACE)
@XmlRootElement(name = "EditText", namespace = AbstractView.LAYOUT_NAMESPACE)
public class EditText extends TextView {
/**
* Serial version UID for serialization.
*/
private static final long serialVersionUID = -6581789315204093529L;
/**
* Type of the edit text element.
*/
private Type type;
/**
* The placeholder specifies a short hint that describes the expected value
* of an input field (e.g. a sample value or a short description of the
* expected format).
*/
private String placeholder;
/**
* Default constructor.
*/
public EditText() {
super();
}
/**
* Creates instance with a defined id.
*
* @param viewId view identity
*/
public EditText(final String viewId) {
super(viewId);
}
/**
* Retrieve the type of the view to display.
*
* @return the type of the view to display
*/
@XmlAttribute(name = "type")
public final Type getType() {
return type;
}
/**
* Sets the type of the text to display.
*
* @param value the type of the view to display
*/
public final void setType(final Type value) {
type = value;
}
/**
* Retrieve a short hint that describes the expected value.
*
* @return a short hint that describes the expected value
*/
@XmlAttribute(name = "placeholder")
public final String getPlaceholder() {
return filter(placeholder);
}
/**
* Sets a short hint that describes the expected value.
*
* @param text a short hint that describes the expected value
*/
public final void setPlaceholder(final String text) {
placeholder = text;
}
/* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(final Object object) {
boolean areEquals;
if (this == object) {
areEquals = true;
} else {
if (object instanceof EditText) {
final EditText that = (EditText) object;
areEquals = super.equals(that)
&& Objects.equals(getText(), that.getText())
&& Objects.equals(placeholder, that.placeholder);
} else {
areEquals = false;
}
}
return areEquals;
}
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return Objects.hash(getViewId(), getText(), placeholder);
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return String.format(
"EditText { "
+ "viewId='%s', "
+ "constraints='%s', "
+ "styleName='%s', "
+ "clickable='%b', "
+ "element='%s', "
+ "text='%s', "
+ "placeholder='%s' "
+ "}",
getViewId(),
getConstraints(),
getStyleName(),
isClickable(),
getElement(),
getText(),
getPlaceholder()
);
}
/**
* The type of the view to display.
*/
@XmlType(namespace = AbstractView.LAYOUT_NAMESPACE)
public static enum Type {
/**
* Defines a clickable button (mostly used with a JavaScript to activate
* a script).
*/
button,
/**
* Defines a checkbox.
*/
checkbox,
/**
* Defines a color picker.
*/
color,
/**
* Defines a date control (year, month and day (no time)).
*/
date,
/**
* Defines a date and time control (year, month, day, hour, minute,
* second, and fraction of a second, based on UTC time zone).
*/
datetime,
/**
* Defines a field for an e-mail address.
*/
email,
/**
* Defines a file-select field and a "Browse..." button (for file
* uploads).
*/
file,
/**
* Defines a hidden input field.
*/
hidden,
/**
* Defines an image as the submit button.
*/
image,
/**
* Defines a month and year control (no time zone).
*/
month,
/**
* Defines a field for entering a number.
*/
number,
/**
* Defines a password field (characters are masked).
*/
password,
/**
* Defines a radio button.
*/
radio,
/**
* Defines a control for entering a number whose exact value
* is not important (like a slider control).
*/
range,
/**
* Defines a reset button (resets all form values to default values).
*/
reset,
/**
* Defines a text field for entering a search string.
*/
search,
/**
* Defines a submit button.
*/
submit,
/**
* Defines a field for entering a telephone number.
*/
tel,
/**
* Default. Defines a single-line text field (default width
* is 20 characters).
*/
text,
/**
* Defines a control for entering a time (no time zone).
*/
time,
/**
* Defines a field for entering a URL.
*/
url,
/**
* Defines a week and year control (no time zone).
*/
week
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy