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.plugin;
034:
035: import com.flexive.faces.beans.MessageBean;
036: import org.apache.commons.lang.StringUtils;
037:
038: /**
039: * <p>
040: * PluginExecutor that allows to add buttons to a toolbar. Pages
041: * are identified by their URI relative to the administration application root (/adm).
042: * For example:
043: * </p>
044: * <table>
045: * <tr>
046: * <th>Target</th>
047: * <th>Matches</th>
048: * </tr>
049: * <tr>
050: * <td>search/query.xhtml</td>
051: * <td>/adm/search/query.xhtml</td>
052: * </tr>
053: * <tr>
054: * <td>search/q*.xhtml</td>
055: * <td>/adm/search/query.xhtml</td>
056: * </tr>
057: * <tr>
058: * <td>search/*</td>
059: * <td>/adm/search/query.xhtml<br/>
060: * /adm/search/resultPreferences.xhtml
061: * </td>
062: * </tr>
063: * <tr>
064: * <td>*</td>
065: * <td>every admin page (not recommended)</td>
066: * </tr>
067: * </table>
068: *
069: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
070: * @version $Rev: 1 $
071: */
072: public interface ToolbarPluginExecutor extends PluginExecutor {
073:
074: /**
075: * Add the given toolbar button to all pages matching the given target.
076: *
077: * @param target the target URL. Look at the {@link ToolbarPluginExecutor} Javadoc for examples.
078: * @param button the button to be added.
079: */
080: void addToolbarButton(String target, Button button);
081:
082: /**
083: * Contains a definition of a single toolbar button. Currently you must either define
084: * a concrete JSF action outcome in "action", or supply a EL-binding for "beans" and
085: * the name of a method in "action". Javascript or absolute URI requests are currently
086: * not supported.
087: */
088: public static class Button {
089: private final String id;
090: private String label;
091: private String bean;
092: private String action;
093: private String icon;
094:
095: public Button(String id) {
096: this .id = id;
097: }
098:
099: public boolean isValid() {
100: return StringUtils.isNotBlank(label)
101: && StringUtils.isNotBlank(action);
102: }
103:
104: public Button setLabel(String label) {
105: this .label = label;
106: return this ;
107: }
108:
109: public Button setLabelKey(String labelKey) {
110: this .label = (String) MessageBean.getInstance().get(
111: labelKey);
112: return this ;
113: }
114:
115: public Button setBean(String bean) {
116: this .bean = bean;
117: return this ;
118: }
119:
120: public Button setAction(String action) {
121: this .action = action;
122: return this ;
123: }
124:
125: public Button setIcon(String icon) {
126: this .icon = icon;
127: return this ;
128: }
129:
130: public String getLabel() {
131: return label;
132: }
133:
134: public String getBean() {
135: return bean;
136: }
137:
138: public String getAction() {
139: return action;
140: }
141:
142: public String getIcon() {
143: return icon;
144: }
145:
146: public String getId() {
147: return id;
148: }
149: }
150: }
|