org.richfaces.component.AbstractCollapsiblePanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of richfaces Show documentation
There is a newer version: 5.0.0.Alpha3
/*
 * JBoss, Home of Professional Open Source
 * Copyright ${year}, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.richfaces.component;

import javax.el.MethodExpression;
import javax.el.ValueExpression;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.event.AbortProcessingException;
import javax.faces.event.FacesEvent;
import javax.faces.event.PhaseId;

import org.richfaces.cdk.annotations.Attribute;
import org.richfaces.cdk.annotations.EventName;
import org.richfaces.cdk.annotations.JsfComponent;
import org.richfaces.cdk.annotations.JsfRenderer;
import org.richfaces.cdk.annotations.Tag;
import org.richfaces.cdk.annotations.TagType;
import org.richfaces.component.attribute.CoreProps;
import org.richfaces.component.attribute.EventsMouseProps;
import org.richfaces.component.attribute.I18nProps;
import org.richfaces.event.ItemChangeEvent;
import org.richfaces.event.PanelToggleEvent;
import org.richfaces.event.PanelToggleListener;
import org.richfaces.event.PanelToggleSource;
import org.richfaces.view.facelets.html.CollapsiblePanelTagHandler;

/**
 * 
 *     The <rich:collapsiblePanel> component is a collapsible panel that shows or hides content when the header bar is activated.
 *     It is a simplified version of <rich:togglePanel> component.
 * 
 * @author akolonitsky
 */
@JsfComponent(tag = @Tag(type = TagType.Facelets, handlerClass = CollapsiblePanelTagHandler.class),
        renderer = @JsfRenderer(type = "org.richfaces.CollapsiblePanelRenderer") )
public abstract class AbstractCollapsiblePanel extends AbstractTogglePanel implements PanelToggleSource, CoreProps, EventsMouseProps, I18nProps {
    public static final String COMPONENT_TYPE = "org.richfaces.CollapsiblePanel";
    public static final String COMPONENT_FAMILY = "org.richfaces.CollapsiblePanel";

    public enum States {
        expanded("exp"),
        collapsed("colps");
        private final String abbreviation;

        States(String abbreviation) {
            this.abbreviation = abbreviation;
        }

        public String abbreviation() {
            return abbreviation;
        }
    }

    public enum Properties {
        expanded
    }

    protected AbstractCollapsiblePanel() {
        setRendererType("org.richfaces.CollapsiblePanelRenderer");
    }

    @Override
    public String getFamily() {
        return COMPONENT_FAMILY;
    }

    @Override
    public String getActiveItem() {
        return String.valueOf(isExpanded());
    }

    @Override
    public boolean isActiveItem(UIComponent kid) {
        return isExpanded();
    }

    @Override
    protected boolean isActiveItem(UIComponent kid, String value) {
        return isExpanded();
    }

    public String updateActiveName(String activeItemName) {
        return getActiveItem();
    }

    /**
     * When true, the panel is expanded, when false, the panel is collapsed
     */
    @Attribute(defaultValue = "true")
    public boolean isExpanded() {
        Object exp = getStateHelper().get(Properties.expanded);
        if (exp != null && exp instanceof Boolean) {
            return (Boolean) exp;
        }

        ValueExpression ve = getValueExpression(Properties.expanded.toString());
        if (ve != null) {
            exp = ve.getValue(FacesContext.getCurrentInstance().getELContext());
            if (exp != null && exp instanceof Boolean) {
                return (Boolean) exp;
            }
        }
        return true;
    }

    public void setExpanded(boolean expanded) {
        ValueExpression ve = getValueExpression(Properties.expanded.toString());
        if (ve != null) {
            if (ve.isReadOnly(FacesContext.getCurrentInstance().getELContext())) {
                getStateHelper().put(Properties.expanded, expanded);
                return;
            }
            ve.setValue(FacesContext.getCurrentInstance().getELContext(), expanded);
            return;
        }

        getStateHelper().put(Properties.expanded, expanded);
    }

    @Attribute(hidden = true)
    public abstract boolean isCycledSwitching();

    @Override
    public void queueEvent(FacesEvent facesEvent) {
        PanelToggleEvent event = null;
        if ((facesEvent instanceof ItemChangeEvent) && (facesEvent.getComponent() == this)) {
            event = new PanelToggleEvent(this, Boolean.valueOf(((ItemChangeEvent) facesEvent).getNewItemName()));
            setEventPhase(event);
        }
        super.queueEvent(event != null ? event : facesEvent);
    }

    // ------------------------------------------------ Component Attributes

    /**
     * 
     * Provides the text on the panel header. The panel header is all that is visible when the panel is collapsed.
     * 
     * 
     * Alternatively the header facet could be used in place of the header attribute.
     * This would allow for additional styles and custom content to be applied to the tab.
     * 
     */
    @Attribute
    public abstract String getHeader();

    /**
     * A Server-side MethodExpression to be called when the panel is toggled
     */
    @Attribute
    public abstract MethodExpression getToggleListener();

    @Attribute(hidden = true)
    public abstract MethodExpression getItemChangeListener();

    // ------------------------------------------------ Html Attributes

    /**
     * The icon displayed on the left of the panel header when the panel is collapsed
     */
    @Attribute
    public abstract String getLeftCollapsedIcon();

    /**
     * The icon displayed on the left of the panel header when the panel is expanded
     */
    @Attribute
    public abstract String getLeftExpandedIcon();

    /**
     * The icon displayed on the right of the panel header when the panel is collapsed
     */
    @Attribute
    public abstract String getRightCollapsedIcon();

    /**
     * The icon displayed on the right of the panel header when the panel is expanded
     */
    @Attribute
    public abstract String getRightExpandedIcon();

    /**
     * Space-separated list of CSS style class(es) to be applied to the panel content. This value must be
     * passed through as the "class" attribute on generated markup.
     */
    @Attribute
    public abstract String getBodyClass();

    /**
     * Space-separated list of CSS style class(es) to be applied to the panel header. This value must be
     * passed through as the "class" attribute on generated markup.
     */
    @Attribute
    public abstract String getHeaderClass();

    /**
     * The client-side script method to be called after the panel state is switched
     */
    @Attribute(events = @EventName("switch"))
    public abstract String getOnswitch();

    /**
     * The client-side script method to be called before the panel state is switched
     */
    @Attribute(events = @EventName("beforeswitch"))
    public abstract String getOnbeforeswitch();

    @Attribute(events = @EventName("beforeitemchange"), hidden = true)
    public abstract String getOnbeforeitemchange();

    @Attribute(events = @EventName("itemchange"), hidden = true)
    public abstract String getOnitemchange();

    // ------------------------------------------------ Event Processing Methods

    public void addPanelToggleListener(PanelToggleListener listener) {
        addFacesListener(listener);
    }

    public PanelToggleListener[] getPanelToggleListeners() {
        return (PanelToggleListener[]) getFacesListeners(PanelToggleListener.class);
    }

    public void removePanelToggleListener(PanelToggleListener listener) {
        removeFacesListener(listener);
    }

    @Override
    @Attribute(hidden = true)
    public Object getValue() {
        return String.valueOf(isExpanded());
    }

    @Override
    public void setValue(Object value) {
        setExpanded(Boolean.parseBoolean((String) value));
    }

    @Override
    public void broadcast(FacesEvent event) throws AbortProcessingException {
        if (event instanceof PanelToggleEvent) {
            setExpanded(((PanelToggleEvent) event).getExpanded());
            setSubmittedActiveItem(null);
            if (event.getPhaseId() != PhaseId.UPDATE_MODEL_VALUES) {
                FacesContext.getCurrentInstance().renderResponse();
            }
        }
        super.broadcast(event);
    }
}