All Downloads are FREE. Search and download functionalities are using the official Maven repository.

atom.view.ViewGroup 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.view;

import atom.widget.AnchorView;
import atom.widget.Button;
import atom.widget.CheckBox;
import atom.widget.DateView;
import atom.widget.EditText;
import atom.widget.GalleryView;
import atom.widget.ImageView;
import atom.widget.LabelView;
import atom.widget.LinearLayout;
import atom.widget.ListView;
import atom.widget.MapPointView;
import atom.widget.MapRegionView;
import atom.widget.MapView;
import atom.widget.RadioButton;
import atom.widget.RadioGroup;
import atom.widget.Slider;
import atom.widget.Spinner;
import atom.widget.TextView;
import atom.widget.UploadView;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElements;
import javax.xml.bind.annotation.XmlType;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

/**
 * A ViewGroup is a special view that can contain other
 * views (called children). The view group is the base class for layouts and
 * views containers.
 *
 * @author Alex Voloshyn
 * @author Serge Voloshyn
 * @author Eugene Shevchenko
 * @version 1.20 6/23/14
 * @see View
 */
@XmlType(namespace = AbstractView.LAYOUT_NAMESPACE)
public abstract class ViewGroup extends View implements ViewSearch.Group {
    /**
     * Use serialVersionUID from JDK 1.0.2 for interoperability.
     */
    private static final long serialVersionUID = 1987332379271969375L;
    /**
     * Children field name.
     */
    public static final String CHILDREN_NAME = "children";
    /**
     * Child views of this ViewGroup.
     */
    private Children children = new Children();

    /**
     * Simple constructor to use when creating a view group from code.
     */
    public ViewGroup() {
        super();
    }

    /**
     * Simple constructor that creates ViewGroup with defined
     * identifier.
     *
     * @param viewId a string used to identify the view
     * @see #setViewId(String)
     */
    public ViewGroup(final String viewId) {
        super(viewId);
    }

    /**
     * Adds a child view. Assign view group as parent to input view.
     * If no layout parameters are already set on the child, the default
     * parameters for this ViewGroup are set on the child.
     *
     * @param child the child view to add
     */
    public final void addView(final View child) {
        child.assignParent(this);
        children.addView(child);
        fireChange(CHILDREN_NAME, children);
    }

    /**
     * Removes a child view from this ViewGroup.
     *
     * @param child the child view to remove
     */
    public final void removeView(final View child) {
        children.removeView(child);
        fireChange(CHILDREN_NAME, children);
    }

    /**
     * Returns the list of children in the group.
     *
     * @return a list representing the children in the group
     * @see #setChildren(List)
     */
    @XmlElements({
            @XmlElement(name = "AnchorView", type = AnchorView.class),
            @XmlElement(name = "Button", type = Button.class),
            @XmlElement(name = "CheckBox", type = CheckBox.class),
            @XmlElement(name = "DateView", type = DateView.class),
            @XmlElement(name = "EditText", type = EditText.class),
            @XmlElement(name = "GalleryView", type = GalleryView.class),
            @XmlElement(name = "ImageView", type = ImageView.class),
            @XmlElement(name = "LabelView", type = LabelView.class),
            @XmlElement(name = "LinearLayout", type = LinearLayout.class),
            @XmlElement(name = "ListView", type = ListView.class),
            @XmlElement(name = "MapView", type = MapView.class),
            @XmlElement(name = "MapPointView", type = MapPointView.class),
            @XmlElement(name = "MapRegionView", type = MapRegionView.class),
            @XmlElement(name = "RadioButton", type = RadioButton.class),
            @XmlElement(name = "RadioGroup", type = RadioGroup.class),
            @XmlElement(name = "Spinner", type = Spinner.class),
            @XmlElement(name = "Slider", type = Slider.class),
            @XmlElement(name = "TextView", type = TextView.class),
            @XmlElement(name = "UploadView", type = UploadView.class)
    })
    public final List getChildren() {
        return children.getChildren();
    }

    /**
     * Sets the list of children in the group.
     *
     * @param views a list representing the children in the group
     */
    public final void setChildren(final List views) {
        children.setChildren(views);
        for (View view : children.children) {
            view.assignParent(this);
        }
        fireChange(CHILDREN_NAME, children);
    }

    @Override
    public final View findChildViewById(final String identity) {
        for (View view : children.getChildren()) {
            final View result = view.findViewById(identity);
            if (result != null) {
                return result;
            }
        }
        return null;
    }

    /* (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 ViewGroup) {
                final ViewGroup that = (ViewGroup) object;
                areEquals = super.equals(that)
                        && Objects.equals(children, that.children);
            } 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(
                "ViewGroup { viewId='%s', styleName='%s',"
                        + " clickable='%b', children='%s' }",
                getViewId(), getStyleName(), isClickable(), children);
    }

    /**
     * View group children wrapper.
     */
    @XmlType(namespace = AbstractView.LAYOUT_NAMESPACE)
    public static class Children implements Serializable {
        /**
         * Use serialVersionUID from JDK 1.0.2 for interoperability.
         */
        private static final long serialVersionUID = 973409170583880094L;

        /**
         * Child views of this ViewGroup.
         */
        private List children = new ArrayList<>();

        /**
         * Returns the list of children in the group.
         *
         * @return a list representing the children in the group
         * @see #setChildren(java.util.List)
         */
        public final List getChildren() {
            return children;
        }

        /**
         * Sets the list of children in the group.
         *
         * @param views a list representing the children in the group
         */
        public final void setChildren(final List views) {
            children = views;
        }

        /**
         * Adds a child view. Assign view group as parent to input view.
         * If no layout parameters are already set on the child, the default
         * parameters for this ViewGroup are set on the child.
         *
         * @param child the child view to add
         */
        public final void addView(final View child) {
            children.add(child);
        }

        /**
         * Removes a child view from children list of this ViewGroup.
         *
         * @param child the child view to remove
         */
        public final void removeView(final View child) {
            children.remove(child);
        }

        /* (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 Children) {
                    final Children that = (Children) object;
                    areEquals = Objects.equals(children, that.children);
                } else {
                    areEquals = false;
                }
            }
            return areEquals;
        }

        /* (non-Javadoc)
         * @see java.lang.Object#hashCode()
         */
        @Override
        public int hashCode() {
            return Objects.hash(children);
        }

        /* (non-Javadoc)
         * @see java.lang.Object#toString()
         */
        @Override
        public String toString() {
            return String.valueOf(children);
        }
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy