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

import javax.xml.bind.annotation.XmlTransient;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

/**
 * Base class for a top-level window look and behavior policy. An instance
 * of this class should be used as the top-level view added to the window
 * manager. It provides standard UI policies such as a background, title
 * area, default key processing, etc.
 *
 * @author Alex Voloshyn
 * @author Serge Voloshyn
 * @version 1.10 10/16/14
 */
public final class Window extends AbstractView {
    /**
     * Format for toString output.
     */
    private static final String TO_STRING_FORMAT =
            "Window { title='%s', contentView='%s', stylesheets='%s' }";
    /**
     * Use serialVersionUID from JDK 1.0.2 for interoperability.
     */
    private static final long serialVersionUID = 6953191636776104313L;
    /**
     * The title associated with this window.
     */
    private String title;
    /**
     * The screen content to an explicit view.
     */
    private View contentView;
    /**
     * Stylesheet links that used this window.
     */
    private List stylesheets = new ArrayList<>();

    /**
     * Retrieve the title associated with this window.
     *
     * @return the title associated with this window
     */
    public String getTitle() {
        return filter(title);
    }

    /**
     * Change the title associated with this window.
     *
     * @param aTitle title associated with this window
     */
    public void setTitle(final String aTitle) {
        title = aTitle;
    }

    /**
     * Retrieve the screen content to an explicit view.
     *
     * @return the screen content to an explicit view
     */
    public View getContentView() {
        return contentView;
    }

    /**
     * Set the screen content to an explicit view. This view is placed directly
     * into the screen's view hierarchy. It can itself be a complex view
     * hierarchy.
     *
     * @param view The desired content to display.
     */
    public void setContentView(final View view) {
        view.assignParent(this);
        contentView = view;
    }

    /**
     * Returns the parent of the view if it exists, or null.
     *
     * @param view - child view that will be processing
     * @return the parent view if found or null otherwise
     */
    @XmlTransient
    public ViewGroup getParentView(final View view) {
        return (ViewGroup) view.getParent();
    }

    /**
     * Adds the stylesheet link from the window.
     *
     * @param stylesheet the stylesheet link to add
     */
    public void addLink(final String stylesheet) {
        stylesheets.add(stylesheet);
    }

    /**
     * Returns the this of stylesheet link.
     *
     * @return a iterator representing the stylesheet link
     * @see #setStylesheets(List)
     */
    public List getStylesheets() {
        return stylesheets;
    }

    /**
     * Sets the this of stylesheet link.
     *
     * @param links a list representing the stylesheet link
     */
    public void setStylesheets(final List links) {
        stylesheets = links;
    }


    /**
     * Finds a view that was identified by the id attribute that was processed
     * in {@link atom.app.Activity#onCreate}.
     *
     * @param identity id attribute that was processed
     * @return the view if found or null otherwise
     */
    @Override
    public View findViewById(final String identity) {
        if (contentView != null) {
            return contentView.findViewById(identity);
        }
        return null;
    }

    /**
     * Call corresponding view attached EventListener.
     *
     * @param identity view identity that fire event
     * @param eventType an event type
     */
    public void handleEvent(final String identity, final int eventType) {
        final View view = findViewById(identity);
        if (view != null) {
            view.handleEvent(eventType);
        }
    }

    /* (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 Window) {
                final Window that = (Window) object;
                areEquals = Objects.equals(title, that.title)
                        && Objects.equals(contentView, that.contentView)
                        && Objects.equals(stylesheets, that.stylesheets);
            } else {
                areEquals = false;
            }
        }
        return areEquals;
    }

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

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return String.format(TO_STRING_FORMAT,
                title, contentView, stylesheets);
    }
}