org.apache.myfaces.custom.toggle.ToggleLinkRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tomahawk21 Show documentation
Show all versions of tomahawk21 Show documentation
JSF components and utilities that can be used with any JSF implementation.
This library is based on the JSF1.1 version of Tomahawk, but with minor source code and build
changes to take advantage of JSF2.1 features. A JSF2.1 implementation is required to use this
version of the Tomahawk library.
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.custom.toggle;
import java.io.IOException;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.faces.component.UIComponent;
import javax.faces.component.UIOutput;
import javax.faces.component.behavior.ClientBehavior;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.myfaces.component.UserRoleUtils;
import org.apache.myfaces.renderkit.html.ext.HtmlLinkRenderer;
import org.apache.myfaces.shared_tomahawk.renderkit.ClientBehaviorEvents;
import org.apache.myfaces.shared_tomahawk.renderkit.RendererUtils;
import org.apache.myfaces.shared_tomahawk.renderkit.html.HTML;
import org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRendererUtils;
/**
* Renderer for component HtmlAjaxChildComboBox
*
*
* @JSFRenderer
* renderKitId = "HTML_BASIC"
* family = "javax.faces.Output"
* type = "org.apache.myfaces.ToggleLink"
*
* @author Sharath Reddy
*/
public class ToggleLinkRenderer extends HtmlLinkRenderer {
public static final int DEFAULT_MAX_SUGGESTED_ITEMS = 200;
protected void renderOutputLinkStart(FacesContext facesContext,
UIOutput output) throws IOException
{
ResponseWriter writer = facesContext.getResponseWriter();
String clientId = output.getClientId(facesContext);
ToggleLink toggleLink = (ToggleLink) output;
//write anchor
writer.startElement(HTML.ANCHOR_ELEM, output);
writer.writeAttribute(HTML.ID_ATTR, clientId, null);
writer.writeAttribute(HTML.NAME_ATTR, clientId, null);
writer.writeURIAttribute(HTML.HREF_ATTR, "javascript:void(0);", null);
Map> behaviors = toggleLink.getClientBehaviors();
if (behaviors != null && !behaviors.isEmpty())
{
HtmlRendererUtils.renderBehaviorizedEventHandlersWithoutOnclick(facesContext, writer, output, behaviors);
HtmlRendererUtils.renderBehaviorizedFieldEventHandlersWithoutOnchangeAndOnselect(facesContext, writer, output, behaviors);
HtmlRendererUtils
.renderHTMLAttributes(
writer,
output,
HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES_WITHOUT_STYLE_AND_EVENTS);
HtmlRendererUtils.renderBehaviorizedAttribute(facesContext, writer, HTML.ONCLICK_ATTR, output,
ClientBehaviorEvents.CLICK, null, behaviors, HTML.ONCLICK_ATTR, null, buildOnclickToggleFunction(facesContext,output));
}
else
{
HtmlRendererUtils
.renderHTMLAttributes(
writer,
output,
HTML.ANCHOR_PASSTHROUGH_ATTRIBUTES_WITHOUT_ONCLICK_WITHOUT_STYLE);
HtmlRendererUtils.renderHTMLAttribute(writer, HTML.ONCLICK_ATTR, HTML.ONCLICK_ATTR,
buildOnclickToggleFunction(facesContext,output));
}
HtmlRendererUtils.renderHTMLAttribute(writer, HTML.STYLE_ATTR, HTML.STYLE_ATTR,
output.getAttributes().get(HTML.STYLE_ATTR));
HtmlRendererUtils.renderHTMLAttribute(writer, HTML.STYLE_CLASS_ATTR, HTML.STYLE_CLASS_ATTR,
output.getAttributes().get(HTML.STYLE_CLASS_ATTR));
writer.flush();
}
protected void renderOutputLinkEnd(FacesContext facesContext, UIComponent component)
throws IOException
{
ResponseWriter writer = facesContext.getResponseWriter();
// force separate end tag
writer.writeText("", null);
writer.endElement(HTML.ANCHOR_ELEM);
}
private String buildOnclickToggleFunction(FacesContext facesContext,
UIOutput output) throws IOException
{
ToggleLink toggleLink = (ToggleLink) output;
TogglePanel togglePanel = getParentTogglePanel(facesContext, toggleLink);
String[] componentsToToggle = toggleLink.getFor().split(",");
String idsToHide = getIdsToHide(facesContext, togglePanel);
StringBuffer idsToShow = new StringBuffer();
for (int i = 0; i < componentsToToggle.length; i++) {
String componentId = componentsToToggle[i].trim();
UIComponent componentToShow = toggleLink.findComponent(componentId);
if (componentToShow == null) {
Log log = LogFactory.getLog(ToggleLinkRenderer.class);
log.error("Unable to find component with id " + componentId);
continue;
}
if( idsToShow.length() > 0 )
idsToShow.append( ',' );
idsToShow.append( componentToShow.getClientId(facesContext) );
}
String outputOnclick = toggleLink.getOnclick();
StringBuffer onClick = new StringBuffer();
if(outputOnclick != null)
{
onClick.append("var cf = function(){");
onClick.append(outputOnclick);
onClick.append('}');
onClick.append(';');
onClick.append("var oamSF = function(){");
}
String onClickFocusClientId = toggleLink.getOnClickFocusId() != null ? toggleLink.findComponent(toggleLink.getOnClickFocusId()).getClientId(facesContext) : "";
onClick.append(getToggleJavascriptFunctionName(facesContext, toggleLink) + "('"+idsToShow+"','" + idsToHide + "','" + getHiddenFieldId(facesContext, togglePanel) + "','" + onClickFocusClientId + "');");
if (outputOnclick != null)
{
onClick.append('}');
onClick.append(';');
onClick.append("return (cf()==false)? false : oamSF();");
}
return onClick.toString();
}
public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
RendererUtils.checkParamValidity(context, component, ToggleLink.class);
ToggleLink toggleLink = (ToggleLink) component;
if(isDisabled(context, toggleLink))
return;
super.encodeEnd(context, component);
}
public void encodeBegin(FacesContext context, UIComponent component) throws IOException {
RendererUtils.checkParamValidity(context, component, ToggleLink.class);
ToggleLink toggleLink = (ToggleLink) component;
if(isDisabled(context, toggleLink))
return;
super.encodeBegin(context, component);
}
private String getToggleJavascriptFunctionName(FacesContext context,ToggleLink toggleLink){
for(UIComponent component = toggleLink.getParent(); component != null; component = component.getParent())
if( component instanceof TogglePanel )
return TogglePanelRenderer.getToggleJavascriptFunctionName( context, (TogglePanel)component );
Log log = LogFactory.getLog(ToggleLinkRenderer.class);
log.error("The ToggleLink component with id " + toggleLink.getClientId( context )+" isn't enclosed in a togglePanel.");
return null;
}
private String getIdsToHide(FacesContext facesContext, TogglePanel togglePanel) {
StringBuffer idsToHide = new StringBuffer();
int idsToHideCount = 0;
for(Iterator it = togglePanel.getChildren().iterator(); it.hasNext(); ) {
UIComponent component = (UIComponent) it.next();
if ( TogglePanelRenderer.isHiddenWhenToggled( component ) ) {
if( idsToHideCount > 0 )
idsToHide.append( ',' );
idsToHide.append( component.getClientId( facesContext ) );
idsToHideCount++;
}
}
return idsToHide.toString();
}
private TogglePanel getParentTogglePanel(FacesContext facesContext, ToggleLink toggleLink) {
for(UIComponent component = toggleLink.getParent(); component != null; component = component.getParent()) {
if( component instanceof TogglePanel )
return (TogglePanel) component;
}
return null;
}
private String getHiddenFieldId(FacesContext context, TogglePanel togglePanel){
return togglePanel.getClientId(context) + "_hidden";
}
private boolean isDisabled(FacesContext facesContext, ToggleLink link) {
TogglePanel panel = getParentTogglePanel(facesContext, link);
return panel.isDisabled() || link.isDisabled() || !UserRoleUtils.isEnabledOnUserRole(link);
}
}