com.github.fluorumlabs.disconnect.vaadin.mixins.HasDataProviderMixin 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.dataproviders.GridDataProvider;
import com.github.fluorumlabs.disconnect.vaadin.elements.mixins.DataProviderMixin;
import com.github.fluorumlabs.disconnect.zero.component.Component;
import js.lang.Any;
import js.lang.Unknown;
import js.util.collections.Array;

import javax.annotation.Nullable;

public interface HasDataProviderMixin, T extends Component>
		extends Component {
	/**
	 * Number of items fetched at a time from the dataprovider.
	 */
	default int pageSize() {
		return getNode().getPageSize();
	}

	/**
	 * Number of items fetched at a time from the dataprovider.
	 */
	default T pageSize(int pageSize) {
		getNode().setPageSize(pageSize);
		return (T) this;
	}

	/**
	 * Function that provides items lazily. Receives arguments params, callback
	 *
	 * params.page Requested page index
	 *
	 * params.pageSize Current page size
	 *
	 * params.filters Currently applied filters
	 *
	 * params.sortOrders Currently applied sorting orders
	 *
	 * params.parentItem When tree is used, and sublevel items
	 * are requested, reference to parent item of the requested sublevel.
	 * Otherwise undefined.
	 *
	 * callback(items, size) Callback function with arguments:
	 *
	 * 
	 * items Current page of items
	 * size Total number of items. When tree sublevel items
	 * are requested, total number of items in the requested sublevel.
	 * Optional when tree is not used, required for tree.
	 * 
	 */
	@Nullable
	default GridDataProvider dataProvider() {
		return getNode().getDataProvider();
	}

	/**
	 * Function that provides items lazily. Receives arguments params, callback
	 *
	 * params.page Requested page index
	 *
	 * params.pageSize Current page size
	 *
	 * params.filters Currently applied filters
	 *
	 * params.sortOrders Currently applied sorting orders
	 *
	 * params.parentItem When tree is used, and sublevel items
	 * are requested, reference to parent item of the requested sublevel.
	 * Otherwise undefined.
	 *
	 * callback(items, size) Callback function with arguments:
	 *
	 * 
	 * items Current page of items
	 * size Total number of items. When tree sublevel items
	 * are requested, total number of items in the requested sublevel.
	 * Optional when tree is not used, required for tree.
	 * 
	 */
	default T dataProvider(GridDataProvider dataProvider) {
		getNode().setDataProvider(dataProvider);
		return (T) this;
	}

	/**
	 * true while data is being requested from the data provider.
	 */
	default boolean loading() {
		return getNode().isLoading();
	}

	/**
	 * Path to an item sub-property that identifies the item.
	 */
	@Nullable
	default String itemIdPath() {
		return getNode().getItemIdPath();
	}

	/**
	 * Path to an item sub-property that identifies the item.
	 */
	default T itemIdPath(String itemIdPath) {
		getNode().setItemIdPath(itemIdPath);
		return (T) this;
	}

	/**
	 * An array that contains the expanded items.
	 */
	@Nullable
	default Array expandedItems() {
		return getNode().getExpandedItems();
	}

	/**
	 * An array that contains the expanded items.
	 */
	default T expandedItems(ITEM... expandedItems) {
		getNode().setExpandedItems(expandedItems);
		return (T) this;
	}

	default T expandedItems(Array expandedItems) {
		getNode().setExpandedItems(expandedItems);
		return (T) this;
	}

	/**
	 * Returns a value that identifies the item. Uses itemIdPath if
	 * available.
	 * Can be customized by overriding.
	 */
	default Unknown getItemId(ITEM item) {
		return getNode().getItemId(item);
	}

	/**
	 * Expands the given item tree.
	 */
	default void expandItem(ITEM item) {
		getNode().expandItem(item);
	}

	/**
	 * Collapses the given item tree.
	 */
	default void collapseItem(ITEM item) {
		getNode().collapseItem(item);
	}

	/**
	 * Clears the cached pages and reloads data from dataprovider when needed.
	 */
	default void clearCache() {
		getNode().clearCache();
	}
}