com.github.fluorumlabs.disconnect.vaadin.mixins.HasItemsMixin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of disconnect-vaadin Show documentation

Vaadin components bindings for Disconnect Zero

The newest version!

package com.github.fluorumlabs.disconnect.vaadin.mixins;

import com.github.fluorumlabs.disconnect.vaadin.elements.mixins.ItemsMixin;
import com.github.fluorumlabs.disconnect.vaadin.types.MenuItem;
import com.github.fluorumlabs.disconnect.zero.component.Component;
import js.util.collections.Array;

public interface HasItemsMixin> extends Component {
	/**
	 * Defines a (hierarchical) menu structure for the component.
	 * If a menu item has a non-empty children set, a sub-menu with the child items is opened
	 * next to the parent menu on mouseover, tap or a right arrow keypress.
	 * 
	 * The items API can't be used together with a renderer or a template!
	 *
	 * 
Example
	 * contextMenu.items = [
	 *   {text: 'Menu Item 1', children:
	 *     [
	 *       {text: 'Menu Item 1-1', checked: true},
	 *       {text: 'Menu Item 1-2'}
	 *     ]
	 *   },
	 *   {component: 'hr'},
	 *   {text: 'Menu Item 2', children:
	 *     [
	 *       {text: 'Menu Item 2-1'},
	 *       {text: 'Menu Item 2-2', disabled: true}
	 *     ]
	 *   },
	 *   {text: 'Menu Item 3', disabled: true}
	 * ];
	 * 
	 */
	default Array items() {
		return getNode().getItems();
	}

	/**
	 * Defines a (hierarchical) menu structure for the component.
	 * If a menu item has a non-empty children set, a sub-menu with the child items is opened
	 * next to the parent menu on mouseover, tap or a right arrow keypress.
	 * 
	 * The items API can't be used together with a renderer or a template!
	 *
	 * 
Example
	 * contextMenu.items = [
	 *   {text: 'Menu Item 1', children:
	 *     [
	 *       {text: 'Menu Item 1-1', checked: true},
	 *       {text: 'Menu Item 1-2'}
	 *     ]
	 *   },
	 *   {component: 'hr'},
	 *   {text: 'Menu Item 2', children:
	 *     [
	 *       {text: 'Menu Item 2-1'},
	 *       {text: 'Menu Item 2-2', disabled: true}
	 *     ]
	 *   },
	 *   {text: 'Menu Item 3', disabled: true}
	 * ];
	 * 
	 */
	default T items(MenuItem... items) {
		getNode().setItems(items);
		return (T) this;
	}

	default T items(Array items) {
		getNode().setItems(items);
		return (T) this;
	}
}