org.dominokit.domino.ui.datatable.ColumnConfig Maven / Gradle / Ivy
/*
* Copyright © 2019 Dominokit
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dominokit.domino.ui.datatable;
import static java.util.Objects.isNull;
import static java.util.Objects.nonNull;
import elemental2.dom.HTMLTableCellElement;
import elemental2.dom.Node;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import org.dominokit.domino.ui.grid.flex.FlexItem;
import org.dominokit.domino.ui.grid.flex.FlexLayout;
import org.dominokit.domino.ui.utils.DominoElement;
import org.dominokit.domino.ui.utils.ScreenMedia;
import org.dominokit.domino.ui.utils.TextNode;
/**
* Class to define a column in the data table
*
* @param the type of the data table records
*/
public class ColumnConfig {
private final String name;
private String title;
private HTMLTableCellElement headElement;
private FlexLayout headerLayout;
private boolean header = false;
private String minWidth;
private String maxWidth;
private String textAlign;
private CellRenderer cellRenderer;
private CellRenderer editableCellRenderer;
private HeaderElementSupplier headerElementSupplier =
columnTitle -> {
return FlexLayout.create()
.appendChild(
FlexItem.of(DominoElement.div())
.setOrder(50)
.setFlexGrow(1)
.styler(style -> style.setCssProperty("text-indent", "2px"))
.appendChild(TextNode.of(columnTitle)))
.element();
};
private CellStyler headerStyler = element -> {};
private CellStyler cellStyler = element -> {};
private boolean sortable = false;
private String sortKey;
private String width;
private boolean fixed = false;
private Node tooltipNode;
private boolean showTooltip = true;
private boolean hidden = false;
private boolean pluginColumn;
private ScreenMedia showOn;
private ScreenMedia hideOn;
private boolean drawTitle = true;
private final List showHideListeners = new ArrayList<>();
private final List permanentHideListeners = new ArrayList<>();
/**
* Creates an instance with a name which will also be used as a title
*
* @param name String, the name of the column
* @param the type of the data table records
* @return new {@link ColumnConfig} instance
*/
public static ColumnConfig create(String name) {
return new ColumnConfig<>(name);
}
/**
* Creates an instance with a name and title
*
* @param name String, the name of the column
* @param title String, the title of the column
* @param the type of the data table records
* @return new {@link ColumnConfig} instance
*/
public static ColumnConfig create(String name, String title) {
return new ColumnConfig<>(name, title);
}
/**
* Creates an instance with a name and title
*
* @param name String, the name of the column
* @param title String, the title of the column
*/
public ColumnConfig(String name, String title) {
this.name = name;
this.title = title;
}
/**
* Creates an instance with a name which will also be used as a title
*
* @param name String, the name of the column
*/
public ColumnConfig(String name) {
this(name, "");
}
/** @return String column title */
public String getTitle() {
return title;
}
/** @return String column name */
public String getName() {
return name;
}
public ColumnConfig asHeader() {
this.header = true;
return this;
}
/**
* @param minWidth String css minimum width for the column
* @return same ColumnConfig instance
*/
public ColumnConfig minWidth(String minWidth) {
this.minWidth = minWidth;
return this;
}
/**
* @param maxWidth String css maximum width for the column
* @return same ColumnConfig instance
*/
public ColumnConfig maxWidth(String maxWidth) {
this.maxWidth = maxWidth;
return this;
}
/**
* @return String the width of the column that we set using the {@link #setWidth(String)} not the
* actual width of the column
*/
public String getWidth() {
return width;
}
/**
* @param width String css width for the column
* @return same ColumnConfig instance
*/
public ColumnConfig setWidth(String width) {
this.width = width;
return this;
}
/**
* @param textAlign String css text align for the column values
* left,right,center
* @return same ColumnConfig instance
*/
public ColumnConfig textAlign(String textAlign) {
this.textAlign = textAlign;
return this;
}
/**
* a shortcut to {@link #setWidth(String)} with value left
*
* @return same ColumnConfig instance
*/
public ColumnConfig alignLeft() {
textAlign("left");
return this;
}
/**
* a shortcut to {@link #setWidth(String)} with value right
*
* @return same ColumnConfig instance
*/
public ColumnConfig alignRight() {
textAlign("right");
return this;
}
/**
* a shortcut to {@link #setWidth(String)} with value center
*
* @return same ColumnConfig instance
*/
public ColumnConfig alignCenter() {
textAlign("center");
return this;
}
/** @return the {@link HeaderElementSupplier} of the column */
@Deprecated
public HeaderElementSupplier getHeaderElement() {
return getHeaderElementSupplier();
}
/** @return the {@link HeaderElementSupplier} of the column */
public HeaderElementSupplier getHeaderElementSupplier() {
return headerElementSupplier;
}
/**
* Sets a custom header element for the column
*
* @param headerElement the {@link HeaderElementSupplier}
* @return same ColumnConfig instance
*/
@Deprecated
public ColumnConfig setHeaderElement(HeaderElementSupplier headerElement) {
return setHeaderElementSupplier(headerElement);
}
/**
* Sets a custom header element for the column
*
* @param headerElement the {@link HeaderElementSupplier}
* @return same ColumnConfig instance
*/
public ColumnConfig setHeaderElementSupplier(HeaderElementSupplier headerElement) {
this.headerElementSupplier = headerElement;
return this;
}
/**
* While rendering the column this will determine if we should build the header with th or td
* elements
*
* @return boolean, if ture use th elements, otherwise use td elements
*/
public boolean isHeader() {
return header;
}
/** @return the String minimum width we set with {@link #minWidth(String)} */
public String getMinWidth() {
return minWidth;
}
/** @return the String maximum width we set with {@link #maxWidth(String)} */
public String getMaxWidth() {
return maxWidth;
}
/** @return the String text align we set with {@link #textAlign(String)} */
public String getTextAlign() {
return textAlign;
}
/**
* @return boolean, if true the column width will be fixed and wont change if the table size
* changed
*/
public boolean isFixed() {
return fixed;
}
/**
* @param fixed boolean, if true the column width will be fixed and wont change when the table
* size is changed.
* @return same ColumnConfig instance.
*/
public ColumnConfig setFixed(boolean fixed) {
this.fixed = fixed;
return this;
}
public ColumnConfig setTitle(String title) {
this.title = title;
return this;
}
/**
* @return the {@link HTMLTableCellElement} that represent this column element wrapped as {@link
* DominoElement}
*/
public DominoElement getHeadElement() {
return DominoElement.of(headElement);
}
/**
* sets a custom element for the column header
*
* @param headElement {@link HTMLTableCellElement}
*/
protected void setHeadElement(HTMLTableCellElement headElement) {
this.headElement = headElement;
}
/** @return the {@link CellRenderer} of this column */
public CellRenderer getCellRenderer() {
return cellRenderer;
}
/**
* sets the cell renderer for this column
*
* @param cellRenderer {@link CellRenderer}
* @return same ColumnConfig instance
*/
public ColumnConfig setCellRenderer(CellRenderer cellRenderer) {
this.cellRenderer = cellRenderer;
if (isNull(editableCellRenderer)) {
this.editableCellRenderer = cellRenderer;
}
return this;
}
/** @return the {@link CellRenderer} of the editable version of this column */
public CellRenderer getEditableCellRenderer() {
if (isNull(editableCellRenderer)) {
return cellRenderer;
}
return editableCellRenderer;
}
/**
* sets the cell renderer to render this column cells in editable mode
*
* @param editableCellRenderer {@link CellRenderer}
* @return same ColumnConfig instance
*/
public ColumnConfig setEditableCellRenderer(CellRenderer editableCellRenderer) {
this.editableCellRenderer = editableCellRenderer;
if (isNull(cellRenderer)) {
this.cellRenderer = editableCellRenderer;
}
return this;
}
/**
* a hook to style a column header
*
* @param headerStyler {@link CellStyler}
* @return same ColumnConfig instance
*/
public ColumnConfig styleHeader(CellStyler headerStyler) {
this.headerStyler = headerStyler;
return this;
}
/**
* a hook to style a cell in the column
*
* @param cellStyler {@link CellStyler}
* @return same ColumnConfig instance
*/
public ColumnConfig styleCell(CellStyler cellStyler) {
this.cellStyler = cellStyler;
return this;
}
/** @return boolean, true if data can be sorted with this column, otherwise false */
public boolean isSortable() {
return sortable;
}
/**
* set wither the column can be used to sort the data or not
*
* @param sortable boolean, if true then data can be sorted with this column, otherwise it cant
* @return same ColumnConfig instance
*/
public ColumnConfig setSortable(boolean sortable) {
return setSortable(sortable, name);
}
/**
* set wither the column can be used to sort the data or not
*
* @param sortable boolean, if true then data can be sorted with this column, otherwise it cant
* @return same ColumnConfig instance
*/
public ColumnConfig setSortable(boolean sortable, String sortKey) {
this.sortable = sortable;
this.sortKey = sortKey;
return this;
}
/**
* a shortcut for {@link #setSortable(boolean)} with value true
*
* @return same ColumnConfig instance
*/
public ColumnConfig sortable() {
return setSortable(true, name);
}
/**
* a shortcut for {@link #setSortable(boolean)} with value true
*
* @param sortKey String key for sort property
* @return same ColumnConfig instance
*/
public ColumnConfig sortable(String sortKey) {
return setSortable(true, sortKey);
}
/**
* force apply screen medias if exists to a cell in this column
*
* @param element {@link HTMLTableCellElement}
*/
public void applyScreenMedia(HTMLTableCellElement element) {
DominoElement thElement = DominoElement.of(element);
if (nonNull(showOn)) {
thElement.showOn(showOn);
}
if (nonNull(hideOn)) {
thElement.hideOn(hideOn);
}
}
/**
* @return the {@link Node} representing the tooltip for this column header if exists otherwise
* return the title node
*/
public Node getTooltipNode() {
if (nonNull(tooltipNode)) return tooltipNode;
else {
return getHeaderElementSupplier().asElement(title);
}
}
/**
* sets a custom tooltip element
*
* @param tooltipNode {@link Node}
* @return same ColumnConfig instance
*/
public ColumnConfig setTooltipNode(Node tooltipNode) {
this.tooltipNode = tooltipNode;
return this;
}
/**
* sets the tooltip text
*
* @param tooltipText String
* @return same ColumnConfig instance
*/
public ColumnConfig setTooltipText(String tooltipText) {
this.tooltipNode = TextNode.of(tooltipText);
return this;
}
/**
* @param showTooltip boolean, if true a tooltip will show up when hover on the column otherwise
* it will not.
* @return same ColumnConfig instance
*/
public ColumnConfig setShowTooltip(boolean showTooltip) {
this.showTooltip = showTooltip;
return this;
}
/** @return the {@link ScreenMedia} that result on showing the column */
public ScreenMedia getShowOn() {
return showOn;
}
/**
* @param showOn {@link ScreenMedia} when is applied the column will be shown
* @return same ColumnConfig instance
*/
public ColumnConfig showOn(ScreenMedia showOn) {
this.showOn = showOn;
return this;
}
/** @return the {@link ScreenMedia} that result on hiding the column */
public ScreenMedia getHideOn() {
return hideOn;
}
/**
* @param hideOn {@link ScreenMedia} when is applied the column will be hidden
* @return same ColumnConfig instance
*/
public ColumnConfig hideOn(ScreenMedia hideOn) {
this.hideOn = hideOn;
return this;
}
/** make the headerStyler apply the styles */
void applyHeaderStyle() {
headerStyler.styleCell(headElement);
}
/**
* make the cellStyler apply the style
*
* @param element {@link HTMLTableCellElement}
*/
void applyCellStyle(HTMLTableCellElement element) {
cellStyler.styleCell(element);
}
/** @return the {@link CellStyler} of the header element */
public CellStyler getHeaderStyler() {
return headerStyler;
}
/** @return the {@link CellStyler} of the cell element */
public CellStyler getCellStyler() {
return cellStyler;
}
/** @return boolean, if true this column show a tooltip otherwise it does not */
public boolean isShowTooltip() {
return showTooltip;
}
/**
* Adds a listener to listen for column hide/show changes
*
* @param showHideListener {@link ColumnShowHideListener}
* @return same ColumnConfig instance
*/
public ColumnConfig addShowHideListener(ColumnShowHideListener showHideListener) {
if (showHideListener.isPermanent()) {
this.permanentHideListeners.add(showHideListener);
} else {
this.showHideListeners.add(showHideListener);
}
return this;
}
/**
* remove the listener
*
* @param showHideListener {@link ColumnShowHideListener}
* @return same ColumnConfig instance
*/
public ColumnConfig removeShowHideListener(ColumnShowHideListener showHideListener) {
if (showHideListener.isPermanent()) {
this.permanentHideListeners.remove(showHideListener);
} else {
this.showHideListeners.remove(showHideListener);
}
return this;
}
/**
* show the column and call the listeners
*
* @return same ColumnConfig instance
*/
public ColumnConfig show() {
this.permanentHideListeners.forEach(showHideListener -> showHideListener.onShowHide(true));
this.showHideListeners.forEach(showHideListener -> showHideListener.onShowHide(true));
this.hidden = false;
return this;
}
/**
* Hides the column and call the listeners
*
* @return same ColumnConfig instance
*/
public ColumnConfig hide() {
this.permanentHideListeners.forEach(showHideListener -> showHideListener.onShowHide(false));
this.showHideListeners.forEach(showHideListener -> showHideListener.onShowHide(false));
this.hidden = true;
return this;
}
/**
* @param visible boolean, if true call {@link #show()} otherwise call {@link #hide()}
* @return
*/
public ColumnConfig toggleDisplay(boolean visible) {
if (visible) {
return show();
} else {
return hide();
}
}
/** @deprecated use {@link ColumnConfig#clearShowHideListeners()} */
@Deprecated
public void clearShowHideListners() {
clearShowHideListeners();
}
/** removes all {@link ColumnShowHideListener}s of this column except the permanent listeners */
public void clearShowHideListeners() {
showHideListeners.clear();
}
/** @return boolean, true if the column is already hidden, otherwise false */
public boolean isHidden() {
return hidden;
}
/** @return boolean, true if the column is registered by a plugin, else false */
public boolean isPluginColumn() {
return pluginColumn;
}
/**
* flags the columns as a plugin column or not
*
* @param pluginColumn boolean, true if the column is being registered by a plugin, else false
* @return same ColumnConfig instance
*/
public ColumnConfig setPluginColumn(boolean pluginColumn) {
this.pluginColumn = pluginColumn;
return this;
}
/** @return String key of the column */
public String getSortKey() {
return Optional.ofNullable(sortKey).orElse(name);
}
/** @return The {@link FlexLayout} of the column header */
public FlexLayout getHeaderLayout() {
return headerLayout;
}
/**
* Use to set a custom header layout
*
* @param headerLayout {@link FlexLayout}
*/
void setHeaderLayout(FlexLayout headerLayout) {
this.headerLayout = headerLayout;
}
/** @return boolean, true of the column is the plugins utility column, otherwise return false */
public final boolean isUtilityColumn() {
return "plugin-utility-column".equals(name);
}
/** @return boolean, true if the column show render the title */
public boolean isDrawTitle() {
return drawTitle;
}
/**
* Set if the column should render its title or not
*
* @param drawTitle boolean
* @return same ColumnConfig instance
*/
public ColumnConfig setDrawTitle(boolean drawTitle) {
this.drawTitle = drawTitle;
return this;
}
/**
* A hook interface to style a cell being rendered on the table
*
* @param the type of the data table records
*/
@FunctionalInterface
public interface CellStyler {
/** @param element the {@link HTMLTableCellElement} to be styled */
void styleCell(HTMLTableCellElement element);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy