org.apache.myfaces.trinidad.component.WrapperEvent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of trinidad-api Show documentation

Public API for the Apache MyFaces Trinidad project

There is a newer version: 2.2.1

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.myfaces.trinidad.component;

import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.event.FacesEvent;
import javax.faces.event.FacesListener;
import javax.faces.event.PhaseId;
import org.apache.myfaces.trinidad.logging.TrinidadLogger;

/**
 * This class wraps a FacesEvent
 */
public class WrapperEvent extends FacesEvent
{
  public WrapperEvent(UIComponent source, FacesEvent wrappedEvent)
  {
    super(source);
    // Event can't be null 
    if (wrappedEvent == null)
      throw new NullPointerException(_LOG.getMessage(
        "WRAPPEDEVENT"));

    _event = wrappedEvent;
  }

  @Override
  public PhaseId getPhaseId()
  {
    return _event.getPhaseId();
  }

  @Override
  public void setPhaseId(PhaseId phaseId)
  {
    _event.setPhaseId(phaseId);
  }

  @Override
  public void processListener(FacesListener listener)
  {
    // This event is never delivered to a listener
    throw new IllegalStateException();
  }

  @Override
  public boolean isAppropriateListener(FacesListener listener)
  {
    // This event is never delivered to a listener
    return false;
  }

  public FacesEvent getEvent()
  {
    return _event;
  }

  /**
   * Broadcasts the original wrapped event from the wrapper event
   * 
   * @param context The current instance of FacesContext
   */
  final public void broadcastWrappedEvent(FacesContext context)
  {
    UIXComponent.broadcastInContext(context, getEvent());
  }

  private final FacesEvent _event;
  private static final TrinidadLogger _LOG = TrinidadLogger.createTrinidadLogger(
    WrapperEvent.class);
  private static final long serialVersionUID = 1L;
}