org.apache.myfaces.trinidadinternal.renderkit.uix.ProgressRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of trinidad-impl Show documentation
Private implementation of the Apache MyFaces Trinidad project
The newest version!
/*
 *  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.trinidadinternal.renderkit.uix;

import java.io.IOException;

import java.util.Map;

import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.event.ActionEvent;

import org.apache.myfaces.trinidad.logging.TrinidadLogger;
import org.apache.myfaces.trinidad.component.UIXProgress;
import org.apache.myfaces.trinidad.model.BoundedRangeModel;

import org.apache.myfaces.trinidadinternal.ui.UIConstants;
import org.apache.myfaces.trinidadinternal.uinode.UINodeRendererBase;

/**
 * Renderer for progress components
 * 
 * @version $Name:  $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/renderkit/uix/ProgressRenderer.java#0 $) $Date: 10-nov-2005.19:00:33 $
 */
public class ProgressRenderer extends UINodeRendererBase
{
  @SuppressWarnings("unchecked")
  @Override
  public void decode(FacesContext context, UIComponent component)
  {
    UIXProgress progressComponent = (UIXProgress)component;
    Map attrs = component.getAttributes();

    Object modelValue= attrs.get(UIConstants.VALUE_PARAM);
    if (modelValue instanceof BoundedRangeModel)
    {
      BoundedRangeModel model = (BoundedRangeModel) modelValue;
      if (model != null)
      {
        long value = model.getValue();
        long maximum = model.getMaximum();
        if (maximum <= value)
        //pu: This means the background task is complete.
        {
          (new ActionEvent(progressComponent)).queue();
        }
      }
    }
  }

  @SuppressWarnings("unchecked")
  @Override
  public void encodeBegin(FacesContext context, UIComponent component)
    throws IOException
  {
    //pu: This seems to be the best place to validate the model for the value
    Map attrs = component.getAttributes();
    Object modelObject = attrs.get(UIConstants.VALUE_PARAM);
    if (modelObject == null || !(modelObject instanceof BoundedRangeModel))
    {
      _LOG.warning("COMPONENT_VALUE_IS_NOT_VALID_BOUNDEDRANGEMODEL_INSTANCE", component.getId());
    }
    super.encodeBegin(context, component);
  }

  static private final TrinidadLogger _LOG = TrinidadLogger.createTrinidadLogger(ProgressRenderer.class);
}