org.chiba.xml.xforms.ui.Switch.java Source code

Java tutorial

Introduction

Here is the source code for org.chiba.xml.xforms.ui.Switch.java

Source

// Copyright 2006 Chibacon
/*
 *
 *    Artistic License
 *
 *    Preamble
 *
 *    The intent of this document is to state the conditions under which a Package may be copied, such that
 *    the Copyright Holder maintains some semblance of artistic control over the development of the
 *    package, while giving the users of the package the right to use and distribute the Package in a
 *    more-or-less customary fashion, plus the right to make reasonable modifications.
 *
 *    Definitions:
 *
 *    "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives
 *    of that collection of files created through textual modification.
 *
 *    "Standard Version" refers to such a Package if it has not been modified, or has been modified
 *    in accordance with the wishes of the Copyright Holder.
 *
 *    "Copyright Holder" is whoever is named in the copyright or copyrights for the package.
 *
 *    "You" is you, if you're thinking about copying or distributing this Package.
 *
 *    "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication
 *    charges, time of people involved, and so on. (You will not be required to justify it to the
 *    Copyright Holder, but only to the computing community at large as a market that must bear the
 *    fee.)
 *
 *    "Freely Available" means that no fee is charged for the item itself, though there may be fees
 *    involved in handling the item. It also means that recipients of the item may redistribute it under
 *    the same conditions they received it.
 *
 *    1. You may make and give away verbatim copies of the source form of the Standard Version of this
 *    Package without restriction, provided that you duplicate all of the original copyright notices and
 *    associated disclaimers.
 *
 *    2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain
 *    or from the Copyright Holder. A Package modified in such a way shall still be considered the
 *    Standard Version.
 *
 *    3. You may otherwise modify your copy of this Package in any way, provided that you insert a
 *    prominent notice in each changed file stating how and when you changed that file, and provided that
 *    you do at least ONE of the following:
 *
 *        a) place your modifications in the Public Domain or otherwise make them Freely
 *        Available, such as by posting said modifications to Usenet or an equivalent medium, or
 *        placing the modifications on a major archive site such as ftp.uu.net, or by allowing the
 *        Copyright Holder to include your modifications in the Standard Version of the Package.
 *
 *        b) use the modified Package only within your corporation or organization.
 *
 *        c) rename any non-standard executables so the names do not conflict with standard
 *        executables, which must also be provided, and provide a separate manual page for each
 *        non-standard executable that clearly documents how it differs from the Standard
 *        Version.
 *
 *        d) make other distribution arrangements with the Copyright Holder.
 *
 *    4. You may distribute the programs of this Package in object code or executable form, provided that
 *    you do at least ONE of the following:
 *
 *        a) distribute a Standard Version of the executables and library files, together with
 *        instructions (in the manual page or equivalent) on where to get the Standard Version.
 *
 *        b) accompany the distribution with the machine-readable source of the Package with
 *        your modifications.
 *
 *        c) accompany any non-standard executables with their corresponding Standard Version
 *        executables, giving the non-standard executables non-standard names, and clearly
 *        documenting the differences in manual pages (or equivalent), together with instructions
 *        on where to get the Standard Version.
 *
 *        d) make other distribution arrangements with the Copyright Holder.
 *
 *    5. You may charge a reasonable copying fee for any distribution of this Package. You may charge
 *    any fee you choose for support of this Package. You may not charge a fee for this Package itself.
 *    However, you may distribute this Package in aggregate with other (possibly commercial) programs as
 *    part of a larger (possibly commercial) software distribution provided that you do not advertise this
 *    Package as a product of your own.
 *
 *    6. The scripts and library files supplied as input to or produced as output from the programs of this
 *    Package do not automatically fall under the copyright of this Package, but belong to whomever
 *    generated them, and may be sold commercially, and may be aggregated with this Package.
 *
 *    7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of
 *    this Package.
 *
 *    8. The name of the Copyright Holder may not be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 *    9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
 *    WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
 *    MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 */
package org.chiba.xml.xforms.ui;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.xerces.dom.NodeImpl;
import org.chiba.xml.events.ChibaEventNames;
import org.chiba.xml.ns.NamespaceConstants;
import org.chiba.xml.xforms.core.Model;
import org.chiba.xml.xforms.exception.XFormsException;
import org.chiba.xml.xforms.ui.state.BoundElementState;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;

/**
 * Implementation of <b>9.2.1 The switch Element</b>.
 *
 * @author Ulrich Nicolas Liss&eacute;
 * @version $Id: Switch.java,v 1.1 2009/02/17 09:00:53 civilis Exp $
 */
public class Switch extends BindingElement {
    protected static Log LOGGER = LogFactory.getLog(Switch.class);
    private Case selected = null;
    private boolean initAfterReady = false;

    /**
     * Creates a new switch element handler.
     *
     * @param element the host document element.
     * @param model the context model.
     */
    public Switch(Element element, Model model) {
        super(element, model);
    }

    // switch specific methods

    /**
     * Returns the currently selected Case.
     *
     * @return the currently selected Case.
     */
    public Case getSelected() {
        return this.selected;
    }

    /**
     * Sets the currently selected Case.
     *
     * @param selected the the currently selected Case.
     */
    public void setSelected(Case selected) {
        this.selected = selected;
    }

    // lifecycle methods

    /**
     * Performs element init.
     *
     * @throws XFormsException if any error occurred during init.
     */
    public void init() throws XFormsException {
        if (getLogger().isDebugEnabled()) {
            getLogger().debug(this + " init");
        }

        initializeDefaultAction();
        initializeInstanceNode();
        initializeElementState();
        initializeChildren();
        initializeSwitch();
    }

    /**
     * Performs element update.
     *
     * @throws XFormsException if any error occurred during update.
     */
    public void refresh() throws XFormsException {
        if (getLogger().isDebugEnabled()) {
            getLogger().debug(this + " update");
        }

        updateElementState();
        updateChildren();
        updateSwitch();
    }

    /**
     * Performs element disposal.
     *
     * @throws XFormsException if any error occurred during disposal.
     */
    public void dispose() throws XFormsException {
        if (getLogger().isDebugEnabled()) {
            getLogger().debug(this + " dispose");
        }

        disposeDefaultAction();
        disposeChildren();
        disposeElementState();
        disposeSwitch();
        disposeSelf();
    }

    // lifecycle template methods

    /**
     * Initializes the Case elements.
     * <p/>
     * If multiple Cases within a Switch are selected, the first selected Case
     * remains and all others are deselected. If none are selected, the first
     * becomes selected.
     */
    protected final void initializeSwitch() throws XFormsException {
        NodeList childNodes = getElement().getChildNodes();
        List cases = new ArrayList(childNodes.getLength());

        Node node;
        Case caseElement;
        String selectedAttribute;
        int selection = -1;

        for (int index = 0; index < childNodes.getLength(); index++) {
            node = childNodes.item(index);

            if (node.getNodeType() == Node.ELEMENT_NODE
                    && NamespaceConstants.XFORMS_NS.equals(node.getNamespaceURI())
                    && CASE.equals(node.getLocalName())) {
                caseElement = (Case) ((NodeImpl) node).getUserData();
                cases.add(caseElement);

                selectedAttribute = caseElement.getXFormsAttribute(SELECTED_ATTRIBUTE);
                if ((selection == -1) && ("true").equals(selectedAttribute)) {
                    // keep *first* selected case position
                    selection = cases.size() - 1;
                }
            }
        }

        if (selection == -1) {
            if (getLogger().isDebugEnabled()) {
                getLogger().debug(this + " init: choosing first case for selection by default");
            }

            // select first case if none is selected
            selection = 0;
        }

        // perform selection/deselection
        for (int index = 0; index < cases.size(); index++) {
            caseElement = (Case) cases.get(index);

            if (index == selection) {
                if (getLogger().isDebugEnabled()) {
                    getLogger().debug(this + " init: selecting case '" + caseElement.getId() + "'");
                }
                caseElement.select();
            } else {
                if (getLogger().isDebugEnabled()) {
                    getLogger().debug(this + " init: deselecting case '" + caseElement.getId() + "'");
                }
                caseElement.deselect();
            }
        }

        // set state for updateSwitch()
        this.initAfterReady = this.model.isReady();
    }

    /**
     * Updates the Switch element.
     */
    protected final void updateSwitch() throws XFormsException {
        // if init happened after xforms-ready we are are part of repeat insert
        // processing so we have to dispatch an event to propagate the initial
        // selection state
        if (this.initAfterReady) {
            // dispatch internal chiba event
            HashMap map = new HashMap();
            map.put("selected", this.selected.getId());
            this.container.dispatch(this.target, ChibaEventNames.SWITCH_TOGGLED, map);

            // reset state to prevent event being dispatched more than once
            this.initAfterReady = false;
        }
    }

    /**
     * Disposes the Switch element.
     */
    protected final void disposeSwitch() {
        this.selected = null;
    }

    // template methods

    /**
     * Factory method for the element state.
     *
     * @return an element state implementation or <code>null</code> if no state
     *         keeping is required.
     * @throws XFormsException if an error occurred during creation.
     */
    protected UIElementState createElementState() throws XFormsException {
        return isBound() ? new BoundElementState(false, false) : null;
    }

}

// end of class