com.jwebmp.plugins.jstree.options.JSTreeContextMenuItemsOptions Maven / Gradle / Ivy
Show all versions of jwebmp-jstree Show documentation
/*
* Copyright (C) 2017 GedMarc
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see
* Each action consists of a key (a unique name) and a value which is an object with the following properties (only label and action are required). Once a menu item is activated
* the action function
* will be invoked with an object containing the following keys: item - the contextmenu item definition as seen below, reference - the DOM node that was used (the tree node),
* element - the contextmenu
* DOM element, position - an object with x/y properties indicating the position of the menu.
*
* separator_before - a boolean indicating if there should be a separator before this item
*
* separator_after - a boolean indicating if there should be a separator after this item
*
* _disabled - a boolean indicating if this action should be disabled
*
* label - a string - the name of the action (could be a function returning a string)
*
* title - a string - an optional tooltip for the item
*
* action - a function to be executed if this item is chosen, the function will receive
*
* icon - a string, can be a path to an icon or a className, if using an image that is in the current directory use a ./ prefix, otherwise it will be detected as a class
*
* shortcut - shortcutKeycode which will trigger the action if the menu is open (for example 113 for rename, which equals F2)
*
* shortcut_label - shortcut label (like for example F2 for rename)
*
* submenu - an object with the same structure as $.jstree.defaults.contextmenu.items which can be used to create a submenu - each key will be rendered as a separate option in a
* submenu that will
* appear once the current item is hovered
*
* @author GedMarc
* @version 1.0
* @since 23 Dec 2016
*/
public class JSTreeContextMenuItemsOptions>
extends JavaScriptPart
{
/**
* a boolean indicating if there should be a separator before this item
*/
@JsonProperty("separator_before")
private Boolean separatorBefore;
/**
* a boolean indicating if there should be a separator after this item
*/
@JsonProperty("separator_after")
private Boolean separatorAfter;
/**
* a boolean indicating if this action should be disabled
*/
@JsonProperty("_disabled")
private Boolean disabled;
/**
* a string - the name of the action (could be a function returning a string)
*/
private String label;
/**
* a string - an optional tooltip for the item
*/
@JsonProperty("title")
private String tooltip;
/**
* a function to be executed if this item is chosen, the function will receive
*/
private JavascriptLiteralFunction action;
/**
* a string, can be a path to an icon or a className,
*
* if using an image that is in the current directory use a ./ prefix, otherwise it will be detected as a class
*/
private String icon;
/**
* shortcutKeycode which will trigger the action if the menu is open (for example 113 for rename, which equals F2)
*/
@JsonProperty("shortcut")
private Integer shortcutKeycode;
/**
* shortcut label (like for example F2 for rename)
*/
@JsonProperty("shortcut_label")
private String shortcutLabel;
/**
* an object with the same structure as $.jstree.defaults.contextmenu.items which can be used to create a submenu - each key will be rendered as a separate option in a submenu
* that will appear
* once the current item is hovered
*/
private JSTreeContextMenuItemsOptions submenu;
public JSTreeContextMenuItemsOptions()
{
//Nothing Needed
}
/**
* a boolean indicating if there should be a separator before this item
*
* @return
*/
public Boolean getSeparatorBefore()
{
return separatorBefore;
}
/**
* a boolean indicating if there should be a separator before this item
*
* @param separatorBefore
*/
@SuppressWarnings("unchecked")
@NotNull
public J setSeparatorBefore(Boolean separatorBefore)
{
this.separatorBefore = separatorBefore;
return (J) this;
}
/**
* a boolean indicating if there should be a separator after this item
*
* @return
*/
public Boolean getSeparatorAfter()
{
return separatorAfter;
}
/**
* a boolean indicating if there should be a separator after this item
*
* @param separatorAfter
*/
@SuppressWarnings("unchecked")
@NotNull
public J setSeparatorAfter(Boolean separatorAfter)
{
this.separatorAfter = separatorAfter;
return (J) this;
}
/**
* a boolean indicating if this action should be disabled
*
* @return
*/
public Boolean getDisabled()
{
return disabled;
}
/**
* a boolean indicating if this action should be disabled
*
* @param disabled
*/
@SuppressWarnings("unchecked")
@NotNull
public J setDisabled(Boolean disabled)
{
this.disabled = disabled;
return (J) this;
}
/**
* a string - the name of the action (could be a function returning a string)
*
* @return
*/
public String getLabel()
{
return label;
}
/**
* a string - the name of the action (could be a function returning a string)
*
* @param label
*/
@SuppressWarnings("unchecked")
@NotNull
public J setLabel(String label)
{
this.label = label;
return (J) this;
}
/**
* a string - an optional tooltip for the item
*
* @return
*/
public String getTooltip()
{
return tooltip;
}
/**
* a string - an optional tooltip for the item
*
* @param tooltip
*/
@SuppressWarnings("unchecked")
@NotNull
public J setTooltip(String tooltip)
{
this.tooltip = tooltip;
return (J) this;
}
/**
* a function to be executed if this item is chosen, the function will receive
*
* @return
*/
public JavascriptLiteralFunction getAction()
{
return action;
}
/**
* a function to be executed if this item is chosen, the function will receive
*
* @param action
*/
@SuppressWarnings("unchecked")
@NotNull
public J setAction(JavascriptLiteralFunction action)
{
this.action = action;
return (J) this;
}
/**
* a string, can be a path to an icon or a className,
*
* if using an image that is in the current directory use a ./ prefix, otherwise it will be detected as a class
*
* @return
*/
public String getIcon()
{
return icon;
}
/**
* a string, can be a path to an icon or a className,
*
* if using an image that is in the current directory use a ./ prefix, otherwise it will be detected as a class
*
* @param icon
*/
@SuppressWarnings("unchecked")
@NotNull
public J setIcon(String icon)
{
this.icon = icon;
return (J) this;
}
/**
* a string, can be a path to an icon or a className,
*
* if using an image that is in the current directory use a ./ prefix, otherwise it will be detected as a class
*
* @param icon
*/
@SuppressWarnings("unchecked")
@NotNull
public J setIcon(Enum icon)
{
this.icon = icon.toString();
return (J) this;
}
/**
* shortcutKeycode which will trigger the action if the menu is open (for example 113 for rename, which equals F2)
*
* @return
*/
public Integer getShortcutKeycode()
{
return shortcutKeycode;
}
/**
* shortcutKeycode which will trigger the action if the menu is open (for example 113 for rename, which equals F2)
*
* @param shortcutKeycode
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShortcutKeycode(Integer shortcutKeycode)
{
this.shortcutKeycode = shortcutKeycode;
return (J) this;
}
/**
* shortcut label (like for example F2 for rename)
*
* @return
*/
public String getShortcutLabel()
{
return shortcutLabel;
}
/**
* shortcut label (like for example F2 for rename)
*
* @param shortcutLabel
*/
@SuppressWarnings("unchecked")
@NotNull
public J setShortcutLabel(String shortcutLabel)
{
this.shortcutLabel = shortcutLabel;
return (J) this;
}
/**
* an object with the same structure as $.jstree.defaults.contextmenu.items which can be used to create a submenu - each key will be rendered as a separate option in a submenu
* that will appear
* once the current item is hovered
*
* @return never null
*/
public JSTreeContextMenuItemsOptions getSubmenu()
{
if (submenu == null)
{
submenu = new JSTreeContextMenuItemsOptions();
}
return submenu;
}
/**
* an object with the same structure as $.jstree.defaults.contextmenu.items which can be used to create a submenu - each key will be rendered as a separate option in a submenu
* that will appear
* once the current item is hovered
*
* @param submenu
*/
@SuppressWarnings("unchecked")
@NotNull
public J setSubmenu(JSTreeContextMenuItemsOptions submenu)
{
this.submenu = submenu;
return (J) this;
}
}