Package ch.systemsx.cisd.openbis.generic.shared.basic.dto

Class ManagedUiTableActionDescription

java.lang.Object

ch.systemsx.cisd.openbis.generic.shared.basic.dto.ManagedUiActionDescription

ch.systemsx.cisd.openbis.generic.shared.basic.dto.ManagedUiTableActionDescription

All Implemented Interfaces:

IManagedUiAction, IManagedUiTableAction, java.io.Serializable

public class ManagedUiTableActionDescription
extends ManagedUiActionDescription
implements IManagedUiTableAction, java.io.Serializable

Object that declaratively describes a UI for an action related to a table (e.g. describing UI of a dialog that should be shown after clicking on a button when some table rows are selected).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ManagedUiTableActionDescription(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
IManagedUiTableAction	addBinding(java.lang.String inputLabel, java.lang.String columnTitle)	Adds a binding between input field and table column.
java.util.Map<java.lang.String,java.lang.String>	getBindings()	Returns map of bindings between input fields and table columns.
java.util.List<java.lang.Integer>	getSelectedRows()	Returns list of indices of selected rows (empty if no row was selected).
ManagedTableActionRowSelectionType	getSelectionType()	Returns selection type specifying when the action should be enabled.
IManagedUiTableAction	setRowSelectionNotRequired()	Sets the selection type to ManagedTableActionRowSelectionType.NOT_REQUIRED.
IManagedUiTableAction	setRowSelectionRequired()	Sets the selection type to ManagedTableActionRowSelectionType.REQUIRED.
IManagedUiTableAction	setRowSelectionRequiredSingle()	Sets the selection type to ManagedTableActionRowSelectionType.REQUIRED_SINGLE.
void	setSelectedRows(java.util.List<java.lang.Integer> selectedRows)

Methods inherited from class ch.systemsx.cisd.openbis.generic.shared.basic.dto.ManagedUiActionDescription

addInputWidgets, getDescription, getInputValue, getInputWidgetDescriptions, getName, getPerson, setDescription, setInputWidgetDescriptions, setPerson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ch.systemsx.cisd.openbis.generic.shared.basic.dto.api.IManagedUiAction

addInputWidgets, getDescription, getInputValue, getInputWidgetDescriptions, getName, getPerson, setDescription

Constructor Detail

ManagedUiTableActionDescription

public ManagedUiTableActionDescription(java.lang.String name)

Method Detail

getSelectionType

public ManagedTableActionRowSelectionType getSelectionType()

Description copied from interface: IManagedUiTableAction

Returns selection type specifying when the action should be enabled.

Specified by:

getSelectionType in interface IManagedUiTableAction

setRowSelectionNotRequired

public IManagedUiTableAction setRowSelectionNotRequired()

Description copied from interface: IManagedUiTableAction

Sets the selection type to ManagedTableActionRowSelectionType.NOT_REQUIRED.

Specified by:

setRowSelectionNotRequired in interface IManagedUiTableAction

Returns:

this (for method chaining)

setRowSelectionRequired

public IManagedUiTableAction setRowSelectionRequired()

Description copied from interface: IManagedUiTableAction

Sets the selection type to ManagedTableActionRowSelectionType.REQUIRED.

Specified by:

setRowSelectionRequired in interface IManagedUiTableAction

Returns:

this (for method chaining)

setRowSelectionRequiredSingle

public IManagedUiTableAction setRowSelectionRequiredSingle()

Description copied from interface: IManagedUiTableAction

Sets the selection type to ManagedTableActionRowSelectionType.REQUIRED_SINGLE.

Specified by:

setRowSelectionRequiredSingle in interface IManagedUiTableAction

Returns:

this (for method chaining)

getSelectedRows

public java.util.List<java.lang.Integer> getSelectedRows()

Description copied from interface: IManagedUiTableAction

Returns list of indices of selected rows (empty if no row was selected).

Specified by:

getSelectedRows in interface IManagedUiTableAction

setSelectedRows

public void setSelectedRows(java.util.List<java.lang.Integer> selectedRows)

addBinding

public IManagedUiTableAction addBinding(java.lang.String inputLabel,
                                        java.lang.String columnTitle)

Description copied from interface: IManagedUiTableAction

Adds a binding between input field and table column.

Specified by:

addBinding in interface IManagedUiTableAction

getBindings

public java.util.Map<java.lang.String,java.lang.String> getBindings()

Description copied from interface: IManagedUiTableAction

Returns map of bindings between input fields and table columns.

Specified by:

getBindings in interface IManagedUiTableAction