org.opencms.gwt.shared.CmsContextMenuEntryBean Maven / Gradle / Ivy
Show all versions of opencms-gwt Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.gwt.shared;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.google.gwt.user.client.rpc.IsSerializable;
/**
* A context menu entry bean.
*/
public class CmsContextMenuEntryBean implements IsSerializable {
/** Signals if the menu entry is active. */
private boolean m_active;
/** The CSS class for the icon. */
private String m_iconClass;
/** Stores the JSP path for the JSP that is called by the command. */
private String m_jspPath;
/** Stores the label for the menu entry. */
private String m_label;
/** The name of the menu entry. */
private String m_name;
/** The map of parameters for the context menu command. */
private Map m_params = new HashMap();
/** The reason for de-activation of the menu entry. */
private String m_reason;
/** Signals if the entry is a separator. */
private boolean m_separator;
/** The items from the sub menu. */
private List m_subMenu;
/** Signals if the menu entry is visible. */
private boolean m_visible;
/**
* Default Constructor.
*/
public CmsContextMenuEntryBean() {
// noop
}
/**
* Constructor.
*
* @param active signals if this menu entry is active
* @param visible signals if this menu entry is visible
* @param jspPath the JSP path for the command
* @param label the label for the menu entry
* @param name the name for the menu entry
* @param reason the reason why this item is deactivated
* @param separator signals if this entry is a separator
* @param subMenu contains the sub menu of the entry
*/
public CmsContextMenuEntryBean(
boolean active,
boolean visible,
String jspPath,
String label,
String name,
String reason,
boolean separator,
List subMenu) {
m_active = active;
m_visible = visible;
m_jspPath = jspPath;
m_label = label;
m_name = name;
m_reason = reason;
m_separator = separator;
m_subMenu = subMenu;
}
/**
* Gets the CSS class used to display an item.
*
* @return the CSS class for the icon
*/
public String getIconClass() {
return m_iconClass;
}
/**
* Returns the jsp path of the menu entry.
*
* @return the jsp path
*/
public String getJspPath() {
return m_jspPath;
}
/**
* Returns the label of the menu entry.
*
* @return the label
*/
public String getLabel() {
return m_label;
}
/**
* Returns the name of the entry.
*
* @return the name of the entry
*/
public String getName() {
return m_name;
}
/**
* Gets the parameters for the context menu command.
*
* @return the parameters
*/
public Map getParams() {
return m_params;
}
/**
* Returns the reason for de-activation of the menu entry.
*
* @return the reason
*/
public String getReason() {
return m_reason;
}
/**
* Returns the sub menu entries.
*
* @return the entries of the sub menu
*/
public List getSubMenu() {
return m_subMenu;
}
/**
* Returns true if this menu entry has a sub menu false otherwise.
*
* @return true if this menu entry has a sub menu false otherwise
*/
public boolean hasSubMenu() {
return (m_subMenu != null) && !m_subMenu.isEmpty();
}
/**
* Returns true if this menu entry is active, false otherwise.
*
* @return true if this menu entry is active, false otherwise
*/
public boolean isActive() {
return m_active;
}
/**
* Returns true if this menu entry is a separator, false otherwise.
*
* @return true if this menu entry is a separator, false otherwise
*/
public boolean isSeparator() {
return m_separator;
}
/**
* Returns true if this menu entry is visible, false otherwise.
*
* @return true if this menu entry is visible, false otherwise
*/
public boolean isVisible() {
return m_visible;
}
/**
* Sets the active.
*
* @param active the active to set
*/
public void setActive(boolean active) {
m_active = active;
}
/**
* Sets CSS class to display an icon.
*
* @param iconClass the CSS class for the icon
*/
public void setIconClass(String iconClass) {
m_iconClass = iconClass;
}
/**
* Sets the jspPath.
*
* @param jspPath the jspPath to set
*/
public void setJspPath(String jspPath) {
m_jspPath = jspPath;
}
/**
* Sets the label.
*
* @param label the label to set
*/
public void setLabel(String label) {
m_label = label;
}
/**
* Sets the name of the entry.
*
* @param name the name to set
*/
public void setName(String name) {
m_name = name;
}
/**
* Sets the parameters for the context menu command.
*
* @param params the parameters for the context menu command
*/
public void setParams(Map params) {
if (params != null) {
m_params = params;
}
}
/**
* Sets the reason.
*
* @param reason the reason to set
*/
public void setReason(String reason) {
m_reason = reason;
}
/**
* Sets the separator.
*
* @param separator the separator to set
*/
public void setSeparator(boolean separator) {
m_separator = separator;
}
/**
* Sets the subMenu.
*
* @param subMenu the subMenu to set
*/
public void setSubMenu(List subMenu) {
m_subMenu = subMenu;
}
/**
* Sets the visible flag.
*
* @param visible the enabled to set
*/
public void setVisible(boolean visible) {
m_visible = visible;
}
}