atom.widget.TextView 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 atom.view.View;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import java.util.Objects;
/**
* Displays text to the user and optionally allows them to edit it. A TextView
* is a complete text editor, however the basic class is configured to not
* allow editing; see {@link TextView} for a subclass that configures the text
* view for editing.
*
* @author Alex Voloshyn
* @author Serge Voloshyn
* @version 1.13 9/26/14
*/
@XmlType(namespace = AbstractView.LAYOUT_NAMESPACE)
@XmlRootElement(name = "TextView", namespace = AbstractView.LAYOUT_NAMESPACE)
public class TextView extends View {
/**
* Serial version UID for serialization.
*/
private static final long serialVersionUID = -1931914533298379881L;
/**
* The programmatic name of the text property.
*/
public static final String TEXT_NAME = "text";
/**
* The text the view to display.
*/
private String text;
/**
* Default constructor.
*/
public TextView() {
super();
}
/**
* Creates instance with a defined id.
*
* @param viewId view identity
*/
public TextView(final String viewId) {
super(viewId);
}
/**
* Return the text the TextView is displaying.
*
* Note: The content of the return value should not be modified. If you want
* a modifiable one, you should make your own copy first.
*
* @return the text the TextView is displaying
*/
@XmlAttribute(name = "text")
public final String getText() {
return filter(text);
}
/**
* Sets the string value of the TextView.
*
* @param txt the text the TextView to display
*/
public final void setText(final String txt) {
setReference(txt);
fireChange(TEXT_NAME, txt);
text = txt;
}
/* (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 TextView) {
final TextView that = (TextView) object;
areEquals = super.equals(that)
&& Objects.equals(text, that.text)
&& Objects.deepEquals(getOptions(),
that.getOptions());
} else {
areEquals = false;
}
}
return areEquals;
}
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return Objects.hash(getViewId(), getElement(), text);
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return String.format(
"TextView { "
+ "viewId='%s', "
+ "binaryPath='%s', "
+ "constraints='%s', "
+ "styleName='%s', "
+ "eventBits='%d', "
+ "element='%s', "
+ "text='%s' "
+ "}",
getViewId(),
getBinaryPath(),
getConstraints(),
getStyleName(),
getEventBits(),
getElement(),
getText()
);
}
}