com.github.fluorumlabs.disconnect.vaadin.mixins.HasStylingMixin 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.StylingMixin;
import com.github.fluorumlabs.disconnect.vaadin.renderers.CellClassNameGenerator;
import com.github.fluorumlabs.disconnect.zero.component.Component;
import js.lang.Any;

import javax.annotation.Nullable;

public interface HasStylingMixin, T extends Component>
		extends Component {
	/**
	 * A function that allows generating CSS class names for grid cells
	 * based on their row and column. The return value should be the generated
	 * class name as a string, or multiple class names separated by whitespace
	 * characters.
	 * 
	 * Receives two arguments:
	 *
	 * 

	 * column The <vaadin-grid-column> element (undefined for
	 * details-cell).
	 * rowData The object with the properties related with
	 * the rendered item, contains:
	 * 
	 * rowData.index The index of the item.
	 * rowData.item The item.
	 * rowData.expanded Sublevel toggle state.
	 * rowData.level Level of the tree represented with a horizontal offset of the toggle button.
	 * rowData.selected Selected state.
	 * 
	 * 
	 * 
	 */
	@Nullable
	default CellClassNameGenerator cellClassNameGenerator() {
		return getNode().getCellClassNameGenerator();
	}

	/**
	 * A function that allows generating CSS class names for grid cells
	 * based on their row and column. The return value should be the generated
	 * class name as a string, or multiple class names separated by whitespace
	 * characters.
	 * 
	 * Receives two arguments:
	 *
	 * 

	 * column The <vaadin-grid-column> element (undefined for
	 * details-cell).
	 * rowData The object with the properties related with
	 * the rendered item, contains:
	 * 
	 * rowData.index The index of the item.
	 * rowData.item The item.
	 * rowData.expanded Sublevel toggle state.
	 * rowData.level Level of the tree represented with a horizontal offset of the toggle button.
	 * rowData.selected Selected state.
	 * 
	 * 
	 * 
	 */
	default T cellClassNameGenerator(CellClassNameGenerator cellClassNameGenerator) {
		getNode().setCellClassNameGenerator(cellClassNameGenerator);
		return (T) this;
	}

	/**
	 * Runs the cellClassNameGenerator for the visible cells.
	 * If the generator depends on varying conditions, you need to
	 * call this function manually in order to update the styles when
	 * the conditions change.
	 */
	default void generateCellClassNames() {
		getNode().generateCellClassNames();
	}
}