001: /***************************************************************
002: * This file is part of the [fleXive](R) project.
003: *
004: * Copyright (c) 1999-2007
005: * UCS - unique computing solutions gmbh (http://www.ucs.at)
006: * All rights reserved
007: *
008: * The [fleXive](R) project is free software; you can redistribute
009: * it and/or modify it under the terms of the GNU General Public
010: * License as published by the Free Software Foundation;
011: * either version 2 of the License, or (at your option) any
012: * later version.
013: *
014: * The GNU General Public License can be found at
015: * http://www.gnu.org/copyleft/gpl.html.
016: * A copy is found in the textfile GPL.txt and important notices to the
017: * license from the author are found in LICENSE.txt distributed with
018: * these libraries.
019: *
020: * This library is distributed in the hope that it will be useful,
021: * but WITHOUT ANY WARRANTY; without even the implied warranty of
022: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
023: * GNU General Public License for more details.
024: *
025: * For further information about UCS - unique computing solutions gmbh,
026: * please see the company website: http://www.ucs.at
027: *
028: * For further information about [fleXive](R), please see the
029: * project website: http://www.flexive.org
030: *
031: *
032: * This copyright notice MUST APPEAR in all copies of the file!
033: ***************************************************************/package com.flexive.faces.components;
034:
035: import com.flexive.faces.FxJsfUtils;
036: import com.flexive.faces.beans.PluginRegistryBean;
037: import com.flexive.faces.plugin.AdmExtensionPoints;
038: import com.flexive.faces.plugin.ToolbarPluginExecutor;
039: import com.sun.facelets.FaceletContext;
040: import com.sun.facelets.FaceletException;
041: import com.sun.facelets.TemplateClient;
042: import com.sun.facelets.el.VariableMapperWrapper;
043: import com.sun.facelets.tag.TagConfig;
044: import com.sun.facelets.tag.TagHandler;
045: import org.apache.commons.logging.Log;
046: import org.apache.commons.logging.LogFactory;
047:
048: import javax.el.ELException;
049: import javax.el.ExpressionFactory;
050: import javax.el.VariableMapper;
051: import javax.faces.FacesException;
052: import javax.faces.component.UIComponent;
053: import java.io.IOException;
054: import java.util.ArrayList;
055: import java.util.List;
056: import java.util.regex.Matcher;
057: import java.util.regex.Pattern;
058:
059: /**
060: * Renders all plugged-in toolbar buttons for the current page (using the commandElement.xhtml
061: * facelets template).
062: *
063: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
064: * @version $Rev: 1 $
065: */
066: public class ToolbarPluginHandler extends TagHandler implements
067: TemplateClient {
068: private static final transient Log LOG = LogFactory
069: .getLog(ToolbarPluginHandler.class);
070:
071: private static final String COMMAND_TEMPLATE = "/adm/templates/commandElement.xhtml";
072:
073: /**
074: * A {@link ToolbarPluginExecutor} that collects all buttons matching the current URI.
075: */
076: private static class Executor implements ToolbarPluginExecutor {
077: private final String uri;
078: private final List<Button> buttons = new ArrayList<Button>();
079:
080: private Executor(String uri) {
081: this .uri = uri;
082: }
083:
084: public void addToolbarButton(String target, Button button) {
085: final Matcher matcher = Pattern.compile(
086: target.replace("*", ".*")).matcher(uri);
087: if (matcher.find()) {
088: buttons.add(button);
089: }
090: }
091:
092: public List<Button> getButtons() {
093: return buttons;
094: }
095: }
096:
097: public ToolbarPluginHandler(TagConfig config) {
098: super (config);
099: }
100:
101: public void apply(FaceletContext ctx, UIComponent parent)
102: throws IOException, FacesException, FaceletException,
103: ELException {
104: // run toolbar plugins
105: final Executor executor = new Executor(FxJsfUtils.getRequest()
106: .getRequestURIWithoutContext());
107: PluginRegistryBean.getInstance().execute(
108: AdmExtensionPoints.ADM_TOOLBAR_PLUGINS, executor);
109: if (LOG.isDebugEnabled()) {
110: LOG.debug("Added " + executor.getButtons().size()
111: + " buttons for " + executor.uri);
112: }
113:
114: final VariableMapper origMapper = ctx.getVariableMapper();
115: final VariableMapperWrapper mapper = new VariableMapperWrapper(
116: origMapper);
117: try {
118: ctx.pushClient(this ); // register ourselve to serve ui:insert requests by the template
119: ctx.setVariableMapper(mapper);
120: final ExpressionFactory factory = ctx
121: .getExpressionFactory();
122: for (ToolbarPluginExecutor.Button button : executor
123: .getButtons()) {
124: // set options for commandElement
125: mapper.setVariable("id", factory.createValueExpression(
126: button.getId(), String.class));
127: mapper.setVariable("label", factory
128: .createValueExpression(button.getLabel(),
129: String.class));
130: mapper
131: .setVariable("bean", factory
132: .createValueExpression(ctx, "#{"
133: + button.getBean() + "}",
134: Object.class));
135: mapper.setVariable("action", factory
136: .createValueExpression(button.getAction(),
137: String.class));
138: mapper.setVariable("icon", factory
139: .createValueExpression(button.getIcon(),
140: String.class));
141: mapper
142: .setVariable("location", factory
143: .createValueExpression("toolbar",
144: String.class));
145:
146: // include template
147: ctx.includeFacelet(parent, COMMAND_TEMPLATE);
148: }
149: } finally {
150: ctx.popClient(this );
151: ctx.setVariableMapper(origMapper);
152: }
153: }
154:
155: public boolean apply(FaceletContext ctx, UIComponent parent,
156: String name) throws IOException, FacesException,
157: FaceletException, ELException {
158: // ignore template requests from the included COMMAND_TEMPLATE since we don't have a body
159: return true;
160: }
161: }
|