org.primefaces.model.menu.DefaultMenuItem 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.model.menu;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import javax.faces.component.UIComponent;
import org.primefaces.component.api.AjaxSource;
import org.primefaces.component.api.UIOutcomeTarget;
public class DefaultMenuItem implements MenuItem, UIOutcomeTarget, AjaxSource, Serializable {
private static final long serialVersionUID = 1L;
private String id;
private String icon;
private String iconPos;
private String title;
private boolean disabled;
private String onclick;
private String style;
private String styleClass;
/**
* The URL to redirect to after the menu item has been clicked. Similar to
* {@code outcome} which allows to specify a navigation case, but the value
* is not touched (no prepending of the contextPath, not appending the
* sessionId or windowId), just encoded.
*
* Specifying a {@code url} which is not {@code null} causes {@code command}
* to be ignored.
*/
private String url;
private String target;
private boolean ajax = true;
private Object value;
/**
* The JSF outcome of a navigation case which is resolved by the configured
* {@code NavigationHandler}. Similar to {@code url}, but {@code url}
* allows to specify fully qualified URLs.
*/
private String outcome;
private boolean includeViewParams;
private String fragment;
private Map> params;
/**
* A method expression in the form of a string which is called after the
* menu item has been clicked. It is ignored when {@code url} is not
* {@code null}.
*/
private String command;
private boolean rendered = true;
private String onstart;
private String onerror;
private String onsuccess;
private String oncomplete;
private String update;
private String process;
private boolean partialSubmit;
private boolean global;
private boolean async;
private boolean partialSubmitSet;
private boolean resetValues;
private boolean resetValuesSet;
private boolean ignoreAutoUpdate;
private boolean immediate;
private String delay;
private int timeout;
private boolean disableClientWindow;
private String containerStyle;
private String containerStyleClass;
private String partialSubmitFilter;
private String confirmationScript;
private String form;
private boolean escape = true;
private String rel;
/**
* Creates a new menu item without value.
*/
public DefaultMenuItem() {
}
/**
* Creates a new menu item with the specified
* @param value the value of the item used as label
*/
public DefaultMenuItem(Object value) {
this.value = value;
}
/**
* Creates a new menu item with the specified
* @param value the value of the item used as label
* @param icon the icon to be displayed next to the label
*/
public DefaultMenuItem(Object value, String icon) {
this.value = value;
this.icon = icon;
}
/**
* Creates a menu item with the specified
* @param value the value of the item used as label
* @param icon the icon to be displayed next to the label
* @param url a URL to redirect to after the menu item has been clicked
* (specifying a {@code url} which is not {@code null} causes
* {@code command} to be ignored) (another form of redirection is provided
* by the {@code outcome} property)
*/
public DefaultMenuItem(Object value, String icon, String url) {
this.value = value;
this.icon = icon;
this.url = url;
}
@Override
public String getId() {
return id;
}
@Override
public void setId(String id) {
this.id = id;
}
@Override
public String getIcon() {
return icon;
}
@Override
public String getIconPos() {
return iconPos;
}
public void setIconPos(String iconPos) {
this.iconPos = iconPos;
}
public void setIcon(String icon) {
this.icon = icon;
}
@Override
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
@Override
public boolean isDisabled() {
return disabled;
}
public void setDisabled(boolean disabled) {
this.disabled = disabled;
}
@Override
public String getOnclick() {
return onclick;
}
public void setOnclick(String onclick) {
this.onclick = onclick;
}
@Override
public String getStyle() {
return style;
}
public void setStyle(String style) {
this.style = style;
}
@Override
public String getStyleClass() {
return styleClass;
}
@Override
public void setStyleClass(String styleClass) {
this.styleClass = styleClass;
}
@Override
public String getHref() {
return url;
}
public void setHref(String href) {
this.url = href;
}
@Override
public String getUrl() {
return url;
}
public void setUrl(String url) {
this.url = url;
}
@Override
public String getTarget() {
return target;
}
public void setTarget(String target) {
this.target = target;
}
@Override
public String getOutcome() {
return outcome;
}
public void setOutcome(String outcome) {
this.outcome = outcome;
}
@Override
public boolean isAjax() {
return ajax;
}
public void setAjax(boolean ajax) {
this.ajax = ajax;
}
@Override
public Object getValue() {
return value;
}
public void setValue(Object value) {
this.value = value;
}
@Override
public boolean isIncludeViewParams() {
return includeViewParams;
}
public void setIncludeViewParams(boolean includeViewParams) {
this.includeViewParams = includeViewParams;
}
@Override
public String getFragment() {
return fragment;
}
public void setFragment(String fragment) {
this.fragment = fragment;
}
@Override
public Map> getParams() {
return params;
}
public void setParams(Map> params) {
this.params = params;
}
@Override
public void setParam(String key, Object value) {
if (value == null) {
throw new IllegalArgumentException("value cannot be null");
}
if (params == null) {
params = new LinkedHashMap<>();
}
if (!params.containsKey(key)) {
params.put(key, new ArrayList());
}
params.get(key).add(value.toString());
}
@Override
public boolean shouldRenderChildren() {
return false;
}
@Override
public List getChildren() {
return null;
}
@Override
public boolean isDynamic() {
return true;
}
@Override
public String getCommand() {
return command;
}
public void setCommand(String command) {
this.command = command;
}
@Override
public boolean isRendered() {
return rendered;
}
public void setRendered(boolean rendered) {
this.rendered = rendered;
}
@Override
public String getOnstart() {
return onstart;
}
public void setOnstart(String onstart) {
this.onstart = onstart;
}
@Override
public String getOnerror() {
return onerror;
}
public void setOnerror(String onerror) {
this.onerror = onerror;
}
@Override
public String getOnsuccess() {
return onsuccess;
}
public void setOnsuccess(String onsuccess) {
this.onsuccess = onsuccess;
}
@Override
public String getOncomplete() {
return oncomplete;
}
public void setOncomplete(String oncomplete) {
this.oncomplete = oncomplete;
}
@Override
public String getUpdate() {
return update;
}
public void setUpdate(String update) {
this.update = update;
}
@Override
public String getProcess() {
return process;
}
public void setProcess(String process) {
this.process = process;
}
@Override
public boolean isPartialSubmit() {
return partialSubmit;
}
public void setPartialSubmit(boolean partialSubmit) {
this.partialSubmit = partialSubmit;
this.partialSubmitSet = true;
}
@Override
public boolean isResetValues() {
return resetValues;
}
public void setResetValues(boolean resetValues) {
this.resetValues = resetValues;
this.resetValuesSet = true;
}
@Override
public boolean isGlobal() {
return global;
}
public void setGlobal(boolean global) {
this.global = global;
}
@Override
public boolean isAsync() {
return async;
}
public void setAsync(boolean async) {
this.async = async;
}
@Override
public boolean isPartialSubmitSet() {
return partialSubmitSet;
}
@Override
public boolean isResetValuesSet() {
return resetValuesSet;
}
@Override
public boolean isIgnoreAutoUpdate() {
return ignoreAutoUpdate;
}
public void setIgnoreAutoUpdate(boolean ignoreAutoUpdate) {
this.ignoreAutoUpdate = ignoreAutoUpdate;
}
@Override
public boolean isImmediate() {
return immediate;
}
public void setImmediate(boolean immediate) {
this.immediate = immediate;
}
@Override
public boolean isAjaxified() {
return getUrl() == null && isAjax();
}
@Override
public String getDelay() {
return delay;
}
public void setDelay(String delay) {
this.delay = delay;
}
@Override
public boolean isDisableClientWindow() {
return disableClientWindow;
}
public void setDisableClientWindow(boolean disableClientWindow) {
this.disableClientWindow = disableClientWindow;
}
@Override
public String getContainerStyle() {
return containerStyle;
}
public void setContainerStyle(String containerStyle) {
this.containerStyle = containerStyle;
}
@Override
public String getContainerStyleClass() {
return containerStyleClass;
}
public void setContainerStyleClass(String containerStyleClass) {
this.containerStyleClass = containerStyleClass;
}
@Override
public String getClientId() {
return this.id;
}
@Override
public int getTimeout() {
return timeout;
}
public void setTimeout(int timeout) {
this.timeout = timeout;
}
@Override
public String getPartialSubmitFilter() {
return partialSubmitFilter;
}
public void setPartialSubmitFilter(String partialSubmitFilter) {
this.partialSubmitFilter = partialSubmitFilter;
}
@Override
public String getForm() {
return form;
}
public void setForm(String form) {
this.form = form;
}
@Override
public String getConfirmationScript() {
return this.confirmationScript;
}
@Override
public void setConfirmationScript(String confirmationScript) {
this.confirmationScript = confirmationScript;
}
@Override
public boolean requiresConfirmation() {
return this.confirmationScript != null;
}
@Override
public boolean isEscape() {
return escape;
}
public void setEscape(boolean escape) {
this.escape = escape;
}
@Override
public String getRel() {
return rel;
}
public void setRel(String rel) {
this.rel = rel;
}
}