de.espirit.firstspirit.ui.gadgets.aspects.operations

Interface SelectStoreElementOperation

public interface SelectStoreElementOperation

Highly configurable operation providing means to select one or more store elements.

Since:

5.0.101

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SelectStoreElementOperation.Selection A selection container providing access to the selected element and remote project name.

Field Summary

Fields

Modifier and Type	Field and Description
static OperationType<SelectStoreElementOperation>	TYPE The operation's type.

Method Summary

Methods

Modifier and Type	Method and Description
ProjectOptions	addProject(String remoteProjectName) Adds the named project as selection source.
void	addProjectFromRestriction(ProjectRestriction projectRestriction) Add a project from a clause representation.
void	addTypeToHide(Class<?> type) Adds a type to be hidden on displaying selectable and navigatable elements.
void	addTypeToSelect(Class<?> type) Adds a type where elements thereof are eligible for selection.
void	applyFilterFolderBased(boolean folderBased) The element selection filter allows/shows only child elements of folders.
List<SelectStoreElementOperation.Selection>	perform() Performs the operation with the previously set configuration and returns the set of selections.
void	selectUiType(SelectUiType uiType) Set the type of user interface which is used to make a selection.
void	setAllowLeafsOnly(boolean leafsOnly) Restricts the final selection to leaf elements, i.e. elements not having any children, real or virtual.
void	setMultiSelect(boolean enable) Enables multiple selection.
void	setPreselection(String projectName, IDProvider element, Resolution resolution) Sets a preselection.
void	setSelectFromRelease(boolean release) Defines, whether released elements will be provided for selection.
void	setSelectResolution(boolean enable) Enables resolution selection on picture elements.
void	setTitle(String title) Sets the selection view's title.

Field Detail

TYPE

static final OperationType<SelectStoreElementOperation> TYPE

The operation's type.

Since:

5.0.101

Method Detail

setTitle

void setTitle(String title)

Sets the selection view's title.

Parameters:

title - The view title.

Since:

5.0.101

setPreselection

void setPreselection(@Nullable
                   String projectName,
                   @NotNull
                   IDProvider element,
                   @Nullable
                   Resolution resolution)

Sets a preselection.

Parameters:

projectName - The symbolic name of the project the element belongs to or null, if it is not remote.

element - The element to be pre-selected.

resolution - The resolution of a picture, if the element refers to a picture.

Since:

5.0.101

setMultiSelect

void setMultiSelect(boolean enable)

Enables multiple selection. If not set, defaults to false.

Parameters:

enable - If true, enables multi selection.

Since:

5.0.101

setSelectResolution

void setSelectResolution(boolean enable)

Enables resolution selection on picture elements. If not set, defaults to false.

Parameters:

enable - If true, enables resolution selection.

Since:

5.0.101

addTypeToSelect

void addTypeToSelect(Class<?> type)

Adds a type where elements thereof are eligible for selection.

Parameters:

type - Type of selectable elements.

Since:

5.0.101

addTypeToHide

void addTypeToHide(Class<?> type)

Adds a type to be hidden on displaying selectable and navigatable elements.

Note: Elements allowed for selection will not be hidden.

Parameters:

type - Type to be hidden.

Since:

5.0.101

addProject

@NotNull
ProjectOptions addProject(@Nullable
                                String remoteProjectName)

Adds the named project as selection source. If the name is null, the local project is added.

Parameters:

remoteProjectName - The symbolic name of the remote project or null.

Returns:

An option handler to further restrict the added project.

Since:

5.0.101

addProjectFromRestriction

void addProjectFromRestriction(@NotNull
                             ProjectRestriction projectRestriction)

Add a project from a clause representation.

Parameters:

projectRestriction - The clause to derive from.

Since:

5.0.101

applyFilterFolderBased

void applyFilterFolderBased(boolean folderBased)

The element selection filter allows/shows only child elements of folders.

Parameters:

folderBased - true if folder based otherwise false

Since:

5.0.101

setAllowLeafsOnly

void setAllowLeafsOnly(boolean leafsOnly)

Restricts the final selection to leaf elements, i.e. elements not having any children, real or virtual.

Parameters:

leafsOnly - true, to allow leafs elements only.

Since:

5.0.101

selectUiType

void selectUiType(@NotNull
                SelectUiType uiType)

Set the type of user interface which is used to make a selection. Defaults to SelectUiType.DIALOG.

Parameters:

uiType - the type used for selection

Since:

5.0.101

setSelectFromRelease

void setSelectFromRelease(boolean release)

Defines, whether released elements will be provided for selection. Default is false, allowing selections of current (unreleased) elements.

Parameters:

release - if true, provides released elements for selection, if false, provides current elements.

Since:

5.0.101

perform

@NotNull
List<SelectStoreElementOperation.Selection> perform()

Performs the operation with the previously set configuration and returns the set of selections.

Returns:

The result of the selection operation.

Since:

5.0.101