atom.widget.RadioGroup 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;
/**
* This class is used to create a multiple-exclusion scope for a set of radio
* buttons. Checking one radio button that belongs to a radio group unchecks
* any previously checked radio button within the same group.
*
* Initially, all of the radio buttons are unchecked. While it is not possible
* to uncheck a particular radio button, the radio group can be cleared to
* remove the checked state.
*
* @author Alex Voloshyn
* @author Serge Voloshyn
* @version 1.2 9/26/14
* @see RadioGroup
*/
@XmlType(namespace = AbstractView.LAYOUT_NAMESPACE)
@XmlRootElement(name = "RadioGroup", namespace = AbstractView.LAYOUT_NAMESPACE)
public final class RadioGroup extends LinearLayout {
/**
* Use serialVersionUID from JDK 1.0.2 for interoperability.
*/
private static final long serialVersionUID = 5729775448706339248L;
/**
* Name of the field containing checked item position value.
*/
public static final String CHECKED_NAME = "checkedPosition";
/**
* Represents an unchecked position. All valid positions are in the range 0
* to 1 less than the number of items.
*/
public static final int UNCHECKED_POSITION = -1;
/**
* Holds the checked id; the selection is empty by default.
*/
private int checkedPosition = UNCHECKED_POSITION;
/**
* Simple constructor to use when creating a radio group from code.
*/
public RadioGroup() {
super();
}
/**
* Simple constructor that creates RadioGroup with defined
* identifier.
*
* @param viewId a string used to identify the view
* @see #setViewId(String)
*/
public RadioGroup(final String viewId) {
super(viewId);
}
/**
* Retrieve the checked id; the selection is empty by default.
*
* @return the checked id; the selection is empty by default
*/
@XmlAttribute(name = "checked")
public int getCheckedPosition() {
return checkedPosition;
}
/**
* Sets the checked id; the selection is empty by default.
*
* @param position the checked id; the selection is empty by default
*/
public void setCheckedPosition(final int position) {
checkedPosition = position;
fireChange(CHECKED_NAME, position);
}
/**
* Returns the selected radio button in this group. Upon empty selection,
* the returned value is null
*
* @return the selected radio button in this group
*/
public RadioButton getCheckedView() {
if (checkedPosition == UNCHECKED_POSITION) {
return null;
}
final View view = getChildren().get(checkedPosition);
if (view == null || !(view instanceof RadioButton)) {
return null;
} else {
return (RadioButton) view;
}
}
/* (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 RadioGroup) {
final RadioGroup that = (RadioGroup) object;
areEquals = super.equals(that)
&& checkedPosition == that.checkedPosition;
} else {
areEquals = false;
}
}
return areEquals;
}
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return Objects.hash(getViewId());
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return String.format(
"RadioGroup { viewId='%s', styleName='%s',"
+ " eventBits='%d', children='%s', checked='%d' }",
getViewId(),
getStyleName(),
getEventBits(),
getChildren(),
getCheckedPosition());
}
}