com.haulmont.cuba.gui.components

Interface TwinColumn<V>

Type Parameters:

V - value and options type for the component

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, DatasourceComponent<java.util.Collection<V>>, Field<java.util.Collection<V>>, HasCaptionMode, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasOptionCaptionProvider<V>, HasValue<java.util.Collection<V>>, HasValueSource<java.util.Collection<V>>, OptionsField<java.util.Collection<V>,V>, Validatable

public interface TwinColumn<V>
extends OptionsField<java.util.Collection<V>,V>, Component.Focusable

A component with two lists: left list for available options, right list for selected values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TwinColumn.OptionStyleProvider<V>
static interface	TwinColumn.StyleProvider Deprecated. use setOptionStyleProvider(OptionStyleProvider)

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator<T>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
int	getColumns() Deprecated. "Columns" does not reflect the exact number of characters that will be displayed. Use Component.getWidth() instead.
java.lang.String	getLeftColumnCaption() Return caption of the left column.
TwinColumn.OptionStyleProvider<V>	getOptionStyleProvider()
java.lang.String	getRightColumnCaption() Return caption of the right column.
int	getRows()
boolean	isAddAllBtnEnabled()
void	setAddAllBtnEnabled(boolean enabled) Enables "Add all" and "Remove all" buttons.
void	setColumns(int columns) Deprecated. "Columns" does not reflect the exact number of characters that will be displayed. Use Component.setWidth(String) instead.
void	setLeftColumnCaption(java.lang.String leftColumnCaption) Set caption for the left column.
void	setOptionStyleProvider(TwinColumn.OptionStyleProvider<V> optionStyleProvider) Sets option style provider.
void	setRightColumnCaption(java.lang.String rightColumnCaption) Set caption for the right column.
void	setRows(int rows) Sets the number of visible rows.
default void	setStyleProvider(TwinColumn.StyleProvider styleProvider) Deprecated. use setOptionStyleProvider(OptionStyleProvider) instead

Methods inherited from interface com.haulmont.cuba.gui.components.OptionsField

getOptions, getOptionsDatasource, getOptionsEnum, getOptionsList, getOptionsMap, setOptions, setOptionsDatasource, setOptionsEnum, setOptionsList, setOptionsMap

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidator, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, removeValueChangeListener, setValue

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.HasOptionCaptionProvider

getOptionCaptionProvider, setOptionCaptionProvider

Methods inherited from interface com.haulmont.cuba.gui.components.HasCaptionMode

getCaptionMode, getCaptionProperty, setCaptionMode, setCaptionProperty

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getColumns

@Deprecated
int getColumns()

Deprecated. "Columns" does not reflect the exact number of characters that will be displayed. Use Component.getWidth() instead.

Gets the number of columns for the component.

See Also:

Component.setWidth(String)

setColumns

@Deprecated
void setColumns(int columns)

Deprecated. "Columns" does not reflect the exact number of characters that will be displayed. Use Component.setWidth(String) instead.

Sets the width of the component so that it displays approximately the given number of letters in each of the two selects.

Parameters:

columns - the number of columns to set.

getRows

int getRows()

Returns:

the number of visible rows

setRows

void setRows(int rows)

Sets the number of visible rows.

Parameters:

rows - number of visible rows

setStyleProvider

@Deprecated
default void setStyleProvider(TwinColumn.StyleProvider styleProvider)

Deprecated. use setOptionStyleProvider(OptionStyleProvider) instead

Parameters:

styleProvider - style provider

setAddAllBtnEnabled

void setAddAllBtnEnabled(boolean enabled)

Enables "Add all" and "Remove all" buttons.

Parameters:

enabled - true if buttons should be enabled

isAddAllBtnEnabled

boolean isAddAllBtnEnabled()

Returns:

true if buttons are enabled

setLeftColumnCaption

void setLeftColumnCaption(java.lang.String leftColumnCaption)

Set caption for the left column.

Parameters:

leftColumnCaption -

getLeftColumnCaption

java.lang.String getLeftColumnCaption()

Return caption of the left column.

Returns:

caption text or null if not set.

setRightColumnCaption

void setRightColumnCaption(java.lang.String rightColumnCaption)

Set caption for the right column.

Parameters:

rightColumnCaption -

getRightColumnCaption

java.lang.String getRightColumnCaption()

Return caption of the right column.

Returns:

caption text or null if not set.

setOptionStyleProvider

void setOptionStyleProvider(TwinColumn.OptionStyleProvider<V> optionStyleProvider)

Sets option style provider. It defines a style for each value.

Parameters:

optionStyleProvider - option style provider function

getOptionStyleProvider

TwinColumn.OptionStyleProvider<V> getOptionStyleProvider()

Returns:

option style provider function