atom.widget.ListView Maven / Gradle / Ivy

Go to download
/*
 * 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 atom.view.ViewGroup;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import java.util.List;
import java.util.Objects;

/**
 * A view that displays list of items.
 * The items in the ListView come from the {@link atom.widget.Adapter}
 * associated with this view.
 *
 * @author Alex Voloshyn
 * @author Serge Voloshyn
 * @author Eugene Shevchenko
 * @version 1.5 4/20/14
 */
@XmlType(namespace = AbstractView.LAYOUT_NAMESPACE)
@XmlRootElement(name = "ListView", namespace = AbstractView.LAYOUT_NAMESPACE)
public class ListView extends AdapterView {
    /**
     * Use serialVersionUID from JDK 1.0.2 for interoperability.
     */
    private static final long serialVersionUID = -4418272632913094008L;
    /**
     * Count of rows that will be display on a single page.
     */
    private int rowsPerPage = Integer.MAX_VALUE;
    /**
     * Item click listener.
     */
    private transient OnItemClickListener listener = null;

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

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

    /**
     * Get rows count that are currently displayed to an user.
     *
     * @return rows count that are currently displayed to an user
     */
    @XmlAttribute(name = "rows-per-page")
    public final int getRowsPerPage() {
        return rowsPerPage;
    }

    /**
     * Set rows count that will be displayed to an user.
     *
     * @param aRowsPerPage rows count that will be displayed to an user
     */
    public final void setRowsPerPage(final int aRowsPerPage) {
        if (aRowsPerPage <= 0) {
            rowsPerPage = Integer.MAX_VALUE;
        } else {
            rowsPerPage = aRowsPerPage;
        }
    }

    /**
     * Sets item click listener.
     *
     * @param aListener new item click listener
     */
    public final void setOnItemClickListener(
            final OnItemClickListener aListener) {
        listener = aListener;
    }

    @SuppressWarnings("unchecked")
    @Override
    public final void adapt() {
        final ListAdapter adapter = getAdapter();

        if (adapter != null) {
            adapter.setRowPerPage(rowsPerPage);
            adapter.setOnItemClickListener(listener);
            final List children = getChildren();
            children.clear();
            final ViewGroup headerView = adapter.getHeaderView();
            final ViewGroup bodyView = adapter.getBodyView();
            final ViewGroup footerView = adapter.getFooterView();

            if (headerView != null) {
                headerView.setViewId(String.valueOf(getViewId())
                        .concat("-header"));
                children.add(headerView);
            }
            if (bodyView != null) {
                if (headerView != null || footerView != null) {
                    bodyView.setViewId(String.valueOf(getViewId())
                            .concat("-body"));
                    bodyView.setClickable(true);
                    children.add(bodyView);
                } else {
                    children.addAll(bodyView.getChildren());
                }
            }
            if (footerView != null) {
                footerView.setViewId(String.valueOf(getViewId())
                        .concat("-footer"));
                children.add(footerView);
            }
            setChildren(children);
        }
    }

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