com.holonplatform.vaadin.internal.components.PropertyColumn Maven / Gradle / Ivy
/*
* Copyright 2016-2017 Axioma srl.
*
* 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 com.holonplatform.vaadin.internal.components;
import java.io.Serializable;
import java.util.List;
import java.util.Optional;
import com.holonplatform.core.i18n.Localizable;
import com.holonplatform.vaadin.components.ItemListing;
import com.holonplatform.vaadin.components.ItemListing.CellStyleGenerator;
import com.holonplatform.vaadin.components.ItemListing.ColumnAlignment;
import com.holonplatform.vaadin.components.builders.ItemListingBuilder.ColumnHeaderMode;
import com.holonplatform.vaadin.data.ItemDataSource.PropertySortGenerator;
import com.vaadin.data.HasValue;
import com.vaadin.data.Validator;
import com.vaadin.data.ValueProvider;
import com.vaadin.server.Resource;
import com.vaadin.ui.Component;
import com.vaadin.ui.renderers.Renderer;
/**
* Interface to collect and provide {@link ItemListing} column properties and settings.
*
* @param Item data type
* @param Item property type
*
* @since 5.0.0
*/
public interface PropertyColumn extends Serializable {
/**
* Get whether this column definition is bound to a virtual column.
* @return Whether this column definition is bound to a virtual column
*/
boolean isVirtual();
/**
* Get the default column display position.
* @return the display position
*/
DisplayPosition getDisplayPosition();
/**
* Set the default column display position.
* @param displayPosition display position to set
*/
void setDisplayPosition(DisplayPosition displayPosition);
/**
* When the column display position is {@link DisplayPosition#RELATIVE_BEFORE} or
* {@link DisplayPosition#RELATIVE_AFTER}, return the property to which the position is relative.
* @return Optional property to which the position is relative to
*/
Optional getDisplayRelativeTo();
/**
* Set the property to which the {@link DisplayPosition} is relative.
* @param property The property to set
*/
void setDisplayRelativeTo(P property);
/**
* When the column display position is {@link DisplayPosition#RELATIVE_BEFORE} or
* {@link DisplayPosition#RELATIVE_AFTER}, return the column id to which the position is relative.
* @return Optional column id to which the position is relative to
*/
Optional getDisplayRelativeToColumnId();
/**
* Set the column id to which the {@link DisplayPosition} is relative.
* @param columnId The column id to set
*/
void setDisplayRelativeToColumnId(String columnId);
/**
* Gets column caption (header)
* @return Column caption (header)
*/
Localizable getCaption();
/**
* Sets column caption (header)
* @param caption Column caption (header)
*/
void setCaption(Localizable caption);
/**
* Get the header (caption) mode.
* @return Column header mode, {@link ColumnHeaderMode#TEXT} by default
*/
ColumnHeaderMode getColumnHeaderMode();
/**
* Set the header (caption) mode.
* @param columnHeaderMode The column header mode to set
*/
void setColumnHeaderMode(ColumnHeaderMode columnHeaderMode);
/**
* Gets column content alignment mode
* @return Column content alignment mode
*/
ColumnAlignment getAlignment();
/**
* Sets column content alignment mode
* @param alignment Column content alignment mode
*/
void setAlignment(ColumnAlignment alignment);
/**
* Gets column width in pixels
* @return Column width in pixels
*/
int getWidth();
/**
* Sets column width in pixels
* @param width Column width in pixels
*/
void setWidth(int width);
/**
* Gets minimum column width in pixels
* @return Minimum column width in pixels
*/
int getMinWidth();
/**
* Sets minimum column width in pixels
* @param minWidth Minimum column width in pixels
*/
void setMinWidth(int minWidth);
/**
* Gets maximum column width in pixels
* @return Maximum column width in pixels
*/
int getMaxWidth();
/**
* Sets maximum column width in pixels
* @param maxWidth Maximum column width in pixels
*/
void setMaxWidth(int maxWidth);
/**
* Gets column expand ratio
* @return Grid column expand ratio
*/
int getExpandRatio();
/**
* Sets column expand ratio
* @param gridExpandRatio Grid column expand ratio
*/
void setExpandRatio(int gridExpandRatio);
/**
* Gets whether the column minimum width has to be calculated using the column content width.
* @return Whether the column minimum width has to be calculated using the column content width
*/
boolean isMinimumWidthFromContent();
/**
* Sets whether the column minimum width has to be calculated using the column content width.
* @param minimumWidthFromContent Whether the column minimum width has to be calculated using the column content
* width
*/
void setMinimumWidthFromContent(boolean minimumWidthFromContent);
/**
* Gets whether the column is editable
* @return true if the column is editable, false otherwise (read-only)
*/
boolean isEditable();
/**
* Sets whether the column is editable
* @param editable true if the column is editable, false otherwise
*/
void setEditable(boolean editable);
/**
* Get the editor field to use for this property column.
* @param Editor field type
* @return the optional editor field
*/
& Component> Optional getEditor();
/**
* Set the editor field to use for this property column.
* @param Editor field type
* @param editor Editor field
*/
& Component> void setEditor(E editor);
/**
* Add a property editor validator.
* @param validator the valdiator to add
*/
void addValidator(Validator validator);
/**
* Get the property editor validators.
* @return property editor validators, empty if none
*/
List> getValidators();
/**
* Get whether the property editor value is required.
* @return whether the property editor value is required
*/
boolean isRequired();
/**
* Set whether the property editor value is required.
* @param required true if the property editor value is required
*/
void setRequired(boolean required);
/**
* Get the required property editor value validation failed message.
* @return the required property editor value validation failed message
*/
Localizable getRequiredMessage();
/**
* Set the required property editor value validation failed message
* @param message required property editor value validation failed message
*/
void setRequiredMessage(Localizable message);
/**
* Gets whether the column is initially hidden when rendered in table
* @return true if the column is initially hidden when rendered in table
*/
boolean isHidden();
/**
* Sets whether the column is initially hidden when rendered in table
* @param hidden true if the column must be initially hidden when rendered in table
*/
void setHidden(boolean hidden);
/**
* Gets whether the column visibility can be toggled by user
* @return true if the column visibility can be toggled by user
*/
boolean isHidable();
/**
* Sets whether the column visibility can be controlled by user
* @param hidable true if the column visibility can be controlled by user
*/
void setHidable(boolean hidable);
/**
* Gets the caption to use for the table menu with which the user can control column visibility
* @return The caption to use for the table menu with which the user can control column visibility
*/
Optional getHidingToggleCaption();
/**
* Sets the caption to use for the table menu with which the user can control column visibility
* @param hidingToggleCaption The caption to use for the table menu with which the user can control column
* visibility
*/
void setHidingToggleCaption(Localizable hidingToggleCaption);
/**
* Gets whether the column can be resized by user
* @return true if the column can be resized by user
*/
boolean isResizable();
/**
* Sets whether the column can be resized by user
* @param resizable true if the column can be resized by user, false otherwise
*/
void setResizable(boolean resizable);
/**
* Gets the column header icon
* @return The column header icon
*/
Optional getIcon();
/**
* Sets the column header icon
* @param icon The column header icon to set
*/
void setIcon(Resource icon);
/**
* Gets an optional {@link CellStyleGenerator} to generate column's cells style
* @return {@link CellStyleGenerator} to generate column's cells style
*/
Optional> getStyle();
/**
* Sets a {@link CellStyleGenerator} to generate column's cells style
* @param cellStyleGenerator The {@link CellStyleGenerator} to generate column's cells style
*/
void setStyle(CellStyleGenerator cellStyleGenerator);
/**
* Get the presentation provider.
* @return Optional presentation provider
*/
Optional> getPresentationProvider();
/**
* Set the presentation provider.
* @param presentationProvider the presentation provider to set
*/
void setPresentationProvider(ValueProvider presentationProvider);
/**
* Gets the {@link Renderer} to use to display column value
* @return The {@link Renderer} to use to display column value
*/
Optional> getRenderer();
/**
* Sets the {@link Renderer} to use to display column value
* @param renderer The {@link Renderer} to use to display column value
*/
void setRenderer(Renderer renderer);
/**
* Get the {@link PropertySortGenerator} to be used to implement the sort logic for this column, if available.
* @return Optional column sort generator
*/
Optional> getPropertySortGenerator();
/**
* Set the {@link PropertySortGenerator} to be used to implement the sort logic for this column.
* @param propertySortGenerator The column sort generator
*/
void setPropertySortGenerator(PropertySortGenerator propertySortGenerator);
/**
* Column display position.
*/
public enum DisplayPosition {
DEFAULT,
HEAD,
TAIL,
RELATIVE_BEFORE,
RELATIVE_AFTER
}
}