com.haulmont.cuba.gui.components.mainwindow

Interface FoldersPane

All Superinterfaces:

Component, Component.BelongToFrame, HasSettings

public interface FoldersPane
extends Component.BelongToFrame, HasSettings

A component displaying a panel with application and search folders.

Nested Class Summary

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

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
java.util.function.Function<AbstractSearchFolder,java.lang.String>	getFolderIconProvider()
void	loadFolders() Initially show the panel and load folders.
void	refreshFolders() Refresh folders if the panel is visible.
void	setFolderIconProvider(java.util.function.Function<AbstractSearchFolder,java.lang.String> iconProvider) Sets the icon provider for the folders.

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

getFrame, setFrame

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, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

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

applySettings, isSettingsEnabled, saveSettings, setSettingsEnabled

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

loadFolders

void loadFolders()

Initially show the panel and load folders. Invoked by the component loader.

refreshFolders

void refreshFolders()

Refresh folders if the panel is visible.

setFolderIconProvider

void setFolderIconProvider(java.util.function.Function<AbstractSearchFolder,java.lang.String> iconProvider)

Sets the icon provider for the folders.

Parameters:

iconProvider - provider which provides icons for the folders

getFolderIconProvider

java.util.function.Function<AbstractSearchFolder,java.lang.String> getFolderIconProvider()

Returns:

icon provider of the folders