/*
* 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 java.io.IOException;
import javax.faces.component.UIComponent;
import javax.faces.component.visit.VisitCallback;
import javax.faces.component.visit.VisitContext;
import javax.faces.component.visit.VisitHint;
import javax.faces.context.FacesContext;
/**
* Base class for the switcher componnet.
* <p>
* @version $Name: $ ($Revision: 1002826 $) $Date: 2010-09-29 13:44:53 -0600 (Wed, 29 Sep 2010) $
*/
abstract public class UIXSwitcherTemplate extends UIXComponentBase implements FlattenedComponent
{
/**/ // Abstract methods implemented by code gen
/**/ abstract public String getFacetName();
/**/ abstract public String getDefaultFacet();
/**
* Only decode the currently active facet.
*/
@Override
public void processDecodes(FacesContext context)
{
UIComponent facet = _getFacet();
if (facet != null)
facet.processDecodes(context);
}
/**
* Only process validations on the currently active facet.
*/
@Override
public void processValidators(FacesContext context)
{
UIComponent facet = _getFacet();
if (facet != null)
facet.processValidators(context);
}
/**
* Only process updates on the currently active facet.
*/
@Override
public void processUpdates(FacesContext context)
{
UIComponent facet = _getFacet();
if (facet != null)
facet.processUpdates(context);
}
/**
* Processes the selected switcher facet
*/
public <S> boolean processFlattenedChildren(
final FacesContext context,
ComponentProcessingContext cpContext,
final ComponentProcessor<S> childProcessor,
final S callbackContext) throws IOException
{
setupVisitingContext(context);
boolean abort;
try
{
UIComponent facet = _getFacet();
if (facet != null)
{
setupChildrenVisitingContext(context);
try
{
abort = UIXComponent.processFlattenedChildren(context,
cpContext,
childProcessor,
facet,
callbackContext);
}
finally
{
tearDownChildrenVisitingContext(context);
}
}
else
{
abort = false;
}
}
finally
{
tearDownChildrenVisitingContext(context);
}
return abort;
}
/**
* Returns <code>true</code> if this FlattenedComponent is currently flattening its children
* @param context FacesContext
* @return <code>true</code> if this FlattenedComponent is currently flattening its children
*/
public boolean isFlatteningChildren(FacesContext context)
{
return true;
}
/**
* Only render the currently active facet.
*/
@Override
public void encodeChildren(FacesContext context)
throws IOException
{
UIComponent facet = _getFacet();
if (facet != null)
{
facet.encodeAll(context);
}
}
/**
* Override to return true.
*/
@Override
public boolean getRendersChildren()
{
return true;
}
@Override
protected boolean visitChildren(
VisitContext visitContext,
VisitCallback callback)
{
if (visitContext.getHints().contains(VisitHint.SKIP_UNRENDERED))
{
UIComponent facet = _getFacet();
if (facet != null)
{
return facet.visitTree(visitContext, callback);
}
return false;
}
else
{
return super.visitChildren(visitContext, callback);
}
}
private UIComponent _getFacet()
{
if (!isRendered())
return null;
String facetName = getFacetName();
if (facetName != null)
{
UIComponent facet = getFacet(facetName);
if (facet != null)
return facet;
}
String defaultFacet = getDefaultFacet();
if (defaultFacet != null)
return getFacet(defaultFacet);
return null;
}
}