org.primefaces.component.menu.BaseMenuRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation
Show all versions of primefaces Show documentation
PrimeFaces is one of the most popular UI libraries in Java EE Ecosystem and widely used by software companies, world renowned brands, banks, financial institutions, insurance companies, universities and more.
/**
* The MIT License
*
* Copyright (c) 2009-2019 PrimeTek
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.primefaces.component.menu;
import java.io.IOException;
import java.util.*;
import javax.faces.FacesException;
import javax.faces.component.UIComponent;
import javax.faces.component.UIForm;
import javax.faces.component.UIParameter;
import javax.faces.component.behavior.ClientBehavior;
import javax.faces.component.behavior.ClientBehaviorContext;
import javax.faces.component.behavior.ClientBehaviorHolder;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.event.PhaseId;
import org.primefaces.behavior.confirm.ConfirmBehavior;
import org.primefaces.component.api.AjaxSource;
import org.primefaces.component.api.UIOutcomeTarget;
import org.primefaces.event.MenuActionEvent;
import org.primefaces.expression.SearchExpressionFacade;
import org.primefaces.model.menu.*;
import org.primefaces.renderkit.OutcomeTargetRenderer;
import org.primefaces.util.ComponentTraversalUtils;
import org.primefaces.util.EscapeUtils;
import org.primefaces.util.SharedStringBuilder;
import org.primefaces.util.WidgetBuilder;
public abstract class BaseMenuRenderer extends OutcomeTargetRenderer {
public static final String SEPARATOR = "_";
private static final String SB_BUILD_NON_AJAX_REQUEST = BaseMenuRenderer.class.getName() + "#buildNonAjaxRequest";
@Override
public void decode(FacesContext context, UIComponent component) {
AbstractMenu menu = (AbstractMenu) component;
String clientId = menu.getClientId(context);
Map params = context.getExternalContext().getRequestParameterMap();
if (params.containsKey(clientId)) {
String menuid = params.get(clientId + "_menuid");
MenuItem menuitem = findMenuitem(menu.getElements(), menuid);
MenuActionEvent event = new MenuActionEvent(menu, menuitem);
if (menuitem.isImmediate()) {
event.setPhaseId(PhaseId.APPLY_REQUEST_VALUES);
}
else {
event.setPhaseId(PhaseId.INVOKE_APPLICATION);
}
menu.queueEvent(event);
}
}
protected MenuItem findMenuitem(List elements, String id) {
if (elements == null || elements.isEmpty()) {
return null;
}
else {
String[] paths = id.split(SEPARATOR);
if (paths.length == 0) {
return null;
}
int childIndex = Integer.parseInt(paths[0]);
if (childIndex >= elements.size()) {
return null;
}
MenuElement childElement = elements.get(childIndex);
if (paths.length == 1) {
return (MenuItem) childElement;
}
else {
String relativeIndex = id.substring(id.indexOf(SEPARATOR) + 1);
return findMenuitem(((MenuGroup) childElement).getElements(), relativeIndex);
}
}
}
@Override
public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
AbstractMenu menu = (AbstractMenu) component;
MenuModel model = menu.getModel();
if (model != null && menu.getElementsCount() > 0) {
model.generateUniqueIds();
}
encodeMarkup(context, menu);
encodeScript(context, menu);
}
protected abstract void encodeMarkup(FacesContext context, AbstractMenu abstractMenu) throws IOException;
protected abstract void encodeScript(FacesContext context, AbstractMenu abstractMenu) throws IOException;
protected String getLinkStyleClass(MenuItem menuItem) {
String styleClass = menuItem.getStyleClass();
return (styleClass == null) ? AbstractMenu.MENUITEM_LINK_CLASS : AbstractMenu.MENUITEM_LINK_CLASS + " " + styleClass;
}
protected void encodeMenuItem(FacesContext context, AbstractMenu menu, MenuItem menuitem) throws IOException {
encodeMenuItem(context, menu, menuitem, "-1");
}
protected void encodeMenuItem(FacesContext context, AbstractMenu menu, MenuItem menuitem, String tabindex) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String title = menuitem.getTitle();
String style = menuitem.getStyle();
boolean disabled = menuitem.isDisabled();
String rel = menuitem.getRel();
writer.startElement("a", null);
writer.writeAttribute("tabindex", tabindex, null);
if (shouldRenderId(menuitem)) {
writer.writeAttribute("id", menuitem.getClientId(), null);
}
if (title != null) {
writer.writeAttribute("title", title, null);
}
String styleClass = getLinkStyleClass(menuitem);
if (disabled) {
styleClass = styleClass + " ui-state-disabled";
}
writer.writeAttribute("class", styleClass, null);
if (style != null) {
writer.writeAttribute("style", style, null);
}
if (rel != null) {
writer.writeAttribute("rel", rel, null);
}
if (disabled) {
writer.writeAttribute("href", "#", null);
writer.writeAttribute("onclick", "return false;", null);
}
else {
setConfirmationScript(context, menuitem);
String onclick = menuitem.getOnclick();
//GET
if (menuitem.getUrl() != null || menuitem.getOutcome() != null) {
String targetURL = getTargetURL(context, (UIOutcomeTarget) menuitem);
writer.writeAttribute("href", targetURL, null);
if (menuitem.getTarget() != null) {
writer.writeAttribute("target", menuitem.getTarget(), null);
}
}
//POST
else {
writer.writeAttribute("href", "#", null);
UIForm form = ComponentTraversalUtils.closestForm(context, menu);
if (form == null) {
throw new FacesException("MenuItem must be inside a form element");
}
String command;
if (menuitem.isDynamic()) {
String menuClientId = menu.getClientId(context);
Map> params = menuitem.getParams();
if (params == null) {
params = new LinkedHashMap<>();
}
List idParams = new ArrayList<>();
idParams.add(menuitem.getId());
params.put(menuClientId + "_menuid", idParams);
command = menuitem.isAjax()
? buildAjaxRequest(context, menu, (AjaxSource) menuitem, form, params)
: buildNonAjaxRequest(context, menu, form, menuClientId, params, true);
}
else {
command = menuitem.isAjax()
? buildAjaxRequest(context, (AjaxSource) menuitem, form)
: buildNonAjaxRequest(context, ((UIComponent) menuitem), form, ((UIComponent) menuitem).getClientId(context), true);
}
onclick = (onclick == null) ? command : onclick + ";" + command;
}
if (onclick != null) {
if (menuitem.requiresConfirmation()) {
writer.writeAttribute("data-pfconfirmcommand", onclick, null);
writer.writeAttribute("onclick", menuitem.getConfirmationScript(), "onclick");
}
else {
writer.writeAttribute("onclick", onclick, null);
}
}
}
encodeMenuItemContent(context, menu, menuitem);
writer.endElement("a");
}
protected void setConfirmationScript(FacesContext context, MenuItem item) {
if (item instanceof ClientBehaviorHolder) {
Map> behaviors = ((ClientBehaviorHolder) item).getClientBehaviors();
List clickBehaviors = (behaviors == null) ? null : behaviors.get("click");
if (clickBehaviors != null && !clickBehaviors.isEmpty()) {
for (int i = 0; i < clickBehaviors.size(); i++) {
ClientBehavior clientBehavior = clickBehaviors.get(i);
if (clientBehavior instanceof ConfirmBehavior) {
ClientBehaviorContext cbc = ClientBehaviorContext.createClientBehaviorContext(
context, (UIComponent) item, "click", item.getClientId(), Collections.EMPTY_LIST);
clientBehavior.getScript(cbc);
break;
}
}
}
}
}
protected boolean shouldRenderId(MenuElement element) {
if (element instanceof UIComponent) {
return shouldWriteId((UIComponent) element);
}
else {
return false;
}
}
protected void encodeMenuItemContent(FacesContext context, AbstractMenu menu, MenuItem menuitem) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String icon = menuitem.getIcon();
Object value = menuitem.getValue();
if (icon != null) {
writer.startElement("span", null);
writer.writeAttribute("class", AbstractMenu.MENUITEM_ICON_CLASS + " " + icon, null);
writer.endElement("span");
}
writer.startElement("span", null);
writer.writeAttribute("class", AbstractMenu.MENUITEM_TEXT_CLASS, null);
if (value != null) {
if (menuitem.isEscape()) {
writer.writeText(value, "value");
}
else {
writer.write(value.toString());
}
}
else if (menuitem.shouldRenderChildren()) {
renderChildren(context, (UIComponent) menuitem);
}
writer.endElement("span");
}
protected void encodeSeparator(FacesContext context, Separator separator) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String style = separator.getStyle();
String styleClass = separator.getStyleClass();
styleClass = styleClass == null ? Menu.SEPARATOR_CLASS : Menu.SEPARATOR_CLASS + " " + styleClass;
//title
writer.startElement("li", null);
writer.writeAttribute("class", styleClass, null);
if (style != null) {
writer.writeAttribute("style", style, null);
}
writer.endElement("li");
}
protected void encodeOverlayConfig(FacesContext context, OverlayMenu menu, WidgetBuilder wb) throws IOException {
wb.attr("overlay", true)
.attr("my", menu.getMy())
.attr("at", menu.getAt());
String trigger = menu.getTrigger();
if (trigger != null) {
wb.attr("trigger", SearchExpressionFacade.resolveClientIds(context, (UIComponent) menu, trigger))
.attr("triggerEvent", menu.getTriggerEvent());
}
}
@Override
public void encodeChildren(FacesContext facesContext, UIComponent component) throws IOException {
//Do nothing
}
@Override
public boolean getRendersChildren() {
return true;
}
protected String buildNonAjaxRequest(FacesContext context, UIComponent component, UIComponent form, String decodeParam,
Map> parameters, boolean submit) {
StringBuilder request = SharedStringBuilder.get(context, SB_BUILD_NON_AJAX_REQUEST);
String formId = form.getClientId(context);
Map params = new HashMap<>();
if (decodeParam != null) {
params.put(decodeParam, decodeParam);
}
for (UIComponent child : component.getChildren()) {
if (child instanceof UIParameter && child.isRendered()) {
UIParameter param = (UIParameter) child;
params.put(param.getName(), param.getValue());
}
}
if (parameters != null && !parameters.isEmpty()) {
for (Iterator it = parameters.keySet().iterator(); it.hasNext(); ) {
String paramName = it.next();
params.put(paramName, parameters.get(paramName).get(0));
}
}
//append params
if (!params.isEmpty()) {
request.append("PrimeFaces.addSubmitParam(\"").append(formId).append("\",{");
for (Iterator it = params.keySet().iterator(); it.hasNext(); ) {
String key = it.next();
Object value = params.get(key);
String valueStr = value == null ? null : EscapeUtils.forJavaScript(value.toString());
request.append("\"").append(EscapeUtils.forJavaScript(key)).append("\":\"").append(valueStr).append("\"");
if (it.hasNext()) {
request.append(",");
}
}
request.append("})");
}
if (submit) {
request.append(".submit(\"").append(formId).append("\");return false;");
}
return request.toString();
}
protected void encodeKeyboardTarget(FacesContext context, AbstractMenu menu) throws IOException {
ResponseWriter writer = context.getResponseWriter();
writer.startElement("div", null);
writer.writeAttribute("tabindex", menu.getTabindex(), null);
writer.writeAttribute("class", "ui-helper-hidden-accessible", null);
writer.endElement("div");
}
}