org.richfaces.event.PanelToggleEvent Maven / Gradle / Ivy
/*
* 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.event;
import javax.faces.component.UIComponent;
import javax.faces.event.FacesEvent;
import javax.faces.event.FacesListener;
/**
* @author akolonitsky
* @since 2010-08-27
*/
public class PanelToggleEvent extends FacesEvent {
private static final long serialVersionUID = 852945229559247489L;
// TODO nick - why not primitive boolean here?
private final Boolean isExpanded;
// ------------------------------------------------------------ Constructors
/**
*
* Construct a new event object from the specified source component, old value, and new value.
*
*
*
* The default {@link javax.faces.event.PhaseId} for this event is {@link javax.faces.event.PhaseId#ANY_PHASE}.
*
*
* @param component Source {@link UIComponent} for this event
* @param isExpanded
*
* @throws IllegalArgumentException if component is null
*/
public PanelToggleEvent(UIComponent component, Boolean isExpanded) {
super(component);
this.isExpanded = isExpanded;
}
// -------------------------------------------------------------- Properties
public Boolean getExpanded() {
return isExpanded;
}
// ------------------------------------------------- Event Broadcast Methods
@Override
public boolean isAppropriateListener(FacesListener listener) {
return listener instanceof PanelToggleListener;
}
/**
* @throws javax.faces.event.AbortProcessingException {@inheritDoc}
*/
@Override
public void processListener(FacesListener listener) {
((PanelToggleListener) listener).processPanelToggle(this);
}
}