org.richfaces.event.ItemChangeEvent 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.event;

import javax.faces.component.UIComponent;
import javax.faces.event.FacesEvent;
import javax.faces.event.FacesListener;

/**
 * 
 * A {@link ItemChangeEvent} is a ...
 * 
 *
 * @author akolonitsky
 * @version 1.0
 * @since -4712-01-01
 */
public class ItemChangeEvent extends FacesEvent {
    private static final long serialVersionUID = -4747704006016875163L;
    private final String oldItemName;
    private final String newItemName;
    private final UIComponent oldItem;
    private final UIComponent newItem;

    // ------------------------------------------------------------ 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 oldItemName
     * @param newItemName
     *
     * @throws IllegalArgumentException if component is null
     */
    public ItemChangeEvent(UIComponent component, String oldItemName, UIComponent oldItem, String newItemName,
        UIComponent newItem) {
        super(component);
        this.oldItemName = oldItemName;
        this.newItemName = newItemName;
        this.oldItem = oldItem;
        this.newItem = newItem;
    }

    // -------------------------------------------------------------- Properties

    public String getOldItemName() {
        return oldItemName;
    }

    public String getNewItemName() {
        return newItemName;
    }

    public UIComponent getOldItem() {
        return oldItem;
    }

    public UIComponent getNewItem() {
        return newItem;
    }

    // ------------------------------------------------- Event Broadcast Methods

    @Override
    public boolean isAppropriateListener(FacesListener listener) {
        return listener instanceof ItemChangeListener;
    }

    /**
     * @throws javax.faces.event.AbortProcessingException {@inheritDoc}
     */
    @Override
    public void processListener(FacesListener listener) {
        ((ItemChangeListener) listener).processItemChange(this);
    }
}