com.haulmont.cuba.web.app.folders

Class CubaFoldersPane

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponentContainer

com.vaadin.ui.AbstractLayout

com.vaadin.ui.AbstractOrderedLayout

com.vaadin.ui.VerticalLayout

com.haulmont.cuba.web.app.folders.CubaFoldersPane

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.LayoutEvents.LayoutClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.ComponentContainer, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.Layout, com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>

public class CubaFoldersPane
extends com.vaadin.ui.VerticalLayout

Left panel containing application and search folders.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CubaFoldersPane.AppFolderGridContextMenu<T extends AppFolder>
class	CubaFoldersPane.AppFoldersUpdater
class	CubaFoldersPane.AppFolderUpdateBackgroundTask
protected static class	CubaFoldersPane.CommandFolderActionAdapter
protected class	CubaFoldersPane.CopyAction
protected class	CubaFoldersPane.CreateAction
protected class	CubaFoldersPane.EditAction
protected class	CubaFoldersPane.ExportAction
protected static class	CubaFoldersPane.FolderAction
protected class	CubaFoldersPane.FolderClickListener<T extends AbstractSearchFolder>
protected class	CubaFoldersPane.FolderGridContextMenu<T extends Folder>
protected static class	CubaFoldersPane.FoldersDataProvider<T extends Folder>
protected static class	CubaFoldersPane.FoldersPaneTimer
protected class	CubaFoldersPane.FolderTreeStyleProvider<T extends AbstractSearchFolder>
protected class	CubaFoldersPane.ImportAction
protected class	CubaFoldersPane.OpenAction
protected class	CubaFoldersPane.RemoveAction
protected class	CubaFoldersPane.SearchFolderGridContextMenu<T extends SearchFolder>

Nested classes/interfaces inherited from class com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractClientConnector.IncorrectConcurrentAccessHandler

Nested classes/interfaces inherited from interface com.vaadin.ui.Layout

com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.Component.HasContextHelp

com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickEvent, com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickListener

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vaadin.ui.Label	appFoldersLabel
protected CubaTree<AppFolder>	appFoldersTree
static java.lang.String	C_FOLDERS_PANE
protected DataService	dataService
protected static int	DEFAULT_VERT_SPLIT_POS
protected EntityStates	entityStates
protected Folders	folders
protected FoldersService	foldersService
protected BackgroundTaskWrapper<java.lang.Integer,java.util.List<AppFolder>>	folderUpdateBackgroundTaskWrapper
protected Frame	frame
protected IconResolver	iconResolver
protected Messages	messages
protected Metadata	metadata
protected com.vaadin.ui.Label	searchFoldersLabel
protected CubaTree<SearchFolder>	searchFoldersTree
protected CubaFoldersPane.FoldersPaneTimer	timer
protected UserSessionSource	userSessionSource
protected UserSettingService	userSettingService
protected UserSettingsTools	userSettingsTools
protected int	verticalSplitPos
protected com.vaadin.ui.VerticalSplitPanel	vertSplit
protected boolean	visible
protected WebConfig	webConfig

Fields inherited from class com.vaadin.ui.AbstractOrderedLayout

ALIGNMENT_DEFAULT, components

Fields inherited from class com.vaadin.ui.AbstractComponent

componentErrorProvider, DESIGN_ATTR_PLAIN_TEXT, requiredError

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
CubaFoldersPane()

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.Component	addFoldersLabel(com.vaadin.ui.AbstractLayout layout, com.vaadin.ui.Label label)
protected java.lang.String	addIdInStr(java.lang.String inputStr, java.util.UUID uuid)
protected void	adjustLayout()
void	asyncReloadAppFolders()
protected <T extends AbstractSearchFolder> void	collapseItemInTree(CubaTree<T> tree, java.lang.String foldersCollapse)
protected com.vaadin.ui.Component	createAppFoldersPane()
protected java.util.function.Consumer<CubaTimer>	createAppFolderUpdater()
protected void	createFoldersPaneLayout(com.vaadin.ui.Component appFoldersPane, com.vaadin.ui.Component searchFoldersPane)
protected CubaVerticalActionsLayout	createFoldersPaneLayout(com.vaadin.ui.Component foldersPane, com.vaadin.ui.Label foldersLabel)
protected com.vaadin.ui.Component	createSearchFoldersPane()
protected <T extends Folder> void	fillTree(CubaTree<T> tree, java.util.List<T> folders)
protected int	folderDepth(Folder folder)
protected com.vaadin.server.Resource	getAppFolderIcon(AppFolder item)
com.vaadin.ui.Tree	getAppFoldersTree()
protected java.util.Collection<AppFolder>	getChildFolders(AppFolder parentFolder)
protected Folder	getFolderParent(Folder folder) Returns a given folder's parent only if it's not marked as deleted, otherwise there will be an exception, because a folder returns a not null parent, but there is no such item in tree as it's not loaded as separate folder as it's marked as deleted.
Frame	getFrame()
protected boolean	getItemClickable(Folder folder)
protected java.util.List<AppFolder>	getReloadedFolders()
protected com.vaadin.server.Resource	getSearchFolderIcon(SearchFolder item)
java.util.Collection<SearchFolder>	getSearchFolders()
com.vaadin.ui.Tree	getSearchFoldersTree()
float	getVerticalSplitPosition()
protected void	handleFoldersPaneShortcutAction(com.vaadin.ui.Component foldersPane)
protected java.lang.String	idsToStr(java.util.List<java.util.UUID> uuids)
protected void	initAppFoldersContextMenu()
protected void	initSearchFoldersContextMenu()
protected boolean	isItemExpandable(Folder folder)
protected boolean	isNeedFoldersTitle()
void	loadFolders()
protected void	openFolder(AbstractSearchFolder folder)
void	refreshFolders()
void	reloadAppFolders()
protected void	reloadParentFolders(java.util.List<AppFolder> reloadedFolders)
protected void	reloadSingleParentFolder(AppFolder parentFolder, java.util.List<AppFolder> reloadedFolders)
void	removeFolder(Folder folder)
protected java.lang.String	removeIdInStr(java.lang.String inputStr, java.util.UUID uuid)
Folder	saveFolder(Folder folder)
void	savePosition()
void	setFrame(Frame frame)
protected void	setupAppFoldersPane(com.vaadin.ui.Component appFoldersPane)
protected void	setupSearchFoldersPane(com.vaadin.ui.Component searchFoldersPane)
protected void	setupUpdateTimer()
void	setVerticalSplitPosition(float verticalSplitPos)
protected void	showFolders(boolean show)
protected void	stopExistingFoldersPaneTimer(AppUI ui)
protected java.util.List<java.util.UUID>	strToIds(java.lang.String inputStr)
protected void	updateFolders(java.util.List<AppFolder> reloadedFolders)

Methods inherited from class com.vaadin.ui.VerticalLayout

addComponentsAndExpand, getState, getState

Methods inherited from class com.vaadin.ui.AbstractOrderedLayout

addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, getComponent, getComponentAlignment, getComponentCount, getComponentIndex, getCustomAttributes, getDefaultComponentAlignment, getExpandRatio, getMargin, isSpacing, iterator, readDesign, removeComponent, removeLayoutClickListener, replaceComponent, setComponentAlignment, setDefaultComponentAlignment, setExpandRatio, setMargin, setMargin, setSpacing, writeDesign

Methods inherited from class com.vaadin.ui.AbstractLayout

isRequiredIndicatorVisible, readMargin, setRequiredIndicatorVisible, writeMargin

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponentAttachListener, addComponentDetachListener, addComponents, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addContextHelpIconClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, ensureContextHelpInitialized, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireContextHelpClick, focus, getActionManager, getCaption, getComponentError, getComponentErrorProvider, getContextHelpText, getCubaId, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getRequiredError, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isContextHelpTextHtmlEnabled, isEnabled, isOrHasAncestor, isReadOnly, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setComponentErrorProvider, setContextHelpText, setContextHelpTextHtmlEnabled, setCubaId, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredError, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getIncorrectConcurrentAccessHandler, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setConnectorResource, setErrorHandler, setIncorrectConcurrentAccessHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponents, getComponentIterator, moveComponentsFrom, removeAllComponents

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getCubaId, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setCubaId, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Field Detail

C_FOLDERS_PANE

public static final java.lang.String C_FOLDERS_PANE

See Also:

Constant Field Values

visible

protected boolean visible

appFoldersTree

protected CubaTree<AppFolder> appFoldersTree

searchFoldersTree

protected CubaTree<SearchFolder> searchFoldersTree

appFoldersLabel

protected com.vaadin.ui.Label appFoldersLabel

searchFoldersLabel

protected com.vaadin.ui.Label searchFoldersLabel

timer

protected CubaFoldersPane.FoldersPaneTimer timer

DEFAULT_VERT_SPLIT_POS

protected static final int DEFAULT_VERT_SPLIT_POS

See Also:

Constant Field Values

verticalSplitPos

protected int verticalSplitPos

vertSplit

protected com.vaadin.ui.VerticalSplitPanel vertSplit

webConfig

protected WebConfig webConfig

messages

protected Messages messages

metadata

protected Metadata metadata

userSessionSource

protected UserSessionSource userSessionSource

userSettingService

protected UserSettingService userSettingService

foldersService

protected FoldersService foldersService

dataService

protected DataService dataService

iconResolver

protected IconResolver iconResolver

userSettingsTools

protected UserSettingsTools userSettingsTools

folders

protected Folders folders

entityStates

protected EntityStates entityStates

folderUpdateBackgroundTaskWrapper

protected BackgroundTaskWrapper<java.lang.Integer,java.util.List<AppFolder>> folderUpdateBackgroundTaskWrapper

frame

protected Frame frame

Constructor Detail

CubaFoldersPane

public CubaFoldersPane()

Method Detail

setVerticalSplitPosition

public void setVerticalSplitPosition(float verticalSplitPos)

getVerticalSplitPosition

public float getVerticalSplitPosition()

loadFolders

public void loadFolders()

showFolders

protected void showFolders(boolean show)

createFoldersPaneLayout

protected void createFoldersPaneLayout(com.vaadin.ui.Component appFoldersPane,
                                       com.vaadin.ui.Component searchFoldersPane)

createFoldersPaneLayout

protected CubaVerticalActionsLayout createFoldersPaneLayout(com.vaadin.ui.Component foldersPane,
                                                            com.vaadin.ui.Label foldersLabel)

handleFoldersPaneShortcutAction

protected void handleFoldersPaneShortcutAction(com.vaadin.ui.Component foldersPane)

setupSearchFoldersPane

protected void setupSearchFoldersPane(com.vaadin.ui.Component searchFoldersPane)

setupUpdateTimer

protected void setupUpdateTimer()

stopExistingFoldersPaneTimer

protected void stopExistingFoldersPaneTimer(AppUI ui)

setupAppFoldersPane

protected void setupAppFoldersPane(com.vaadin.ui.Component appFoldersPane)

collapseItemInTree

protected <T extends AbstractSearchFolder> void collapseItemInTree(CubaTree<T> tree,
                                                                   java.lang.String foldersCollapse)

addIdInStr

protected java.lang.String addIdInStr(java.lang.String inputStr,
                                      java.util.UUID uuid)

removeIdInStr

protected java.lang.String removeIdInStr(java.lang.String inputStr,
                                         java.util.UUID uuid)

strToIds

protected java.util.List<java.util.UUID> strToIds(java.lang.String inputStr)

idsToStr

protected java.lang.String idsToStr(java.util.List<java.util.UUID> uuids)

addFoldersLabel

protected com.vaadin.ui.Component addFoldersLabel(com.vaadin.ui.AbstractLayout layout,
                                                  com.vaadin.ui.Label label)

savePosition

public void savePosition()

createAppFolderUpdater

protected java.util.function.Consumer<CubaTimer> createAppFolderUpdater()

refreshFolders

public void refreshFolders()

reloadAppFolders

public void reloadAppFolders()

asyncReloadAppFolders

public void asyncReloadAppFolders()

reloadParentFolders

protected void reloadParentFolders(java.util.List<AppFolder> reloadedFolders)

getChildFolders

protected java.util.Collection<AppFolder> getChildFolders(AppFolder parentFolder)

reloadSingleParentFolder

protected void reloadSingleParentFolder(AppFolder parentFolder,
                                        @Nullable
                                        java.util.List<AppFolder> reloadedFolders)

getReloadedFolders

protected java.util.List<AppFolder> getReloadedFolders()

updateFolders

protected void updateFolders(java.util.List<AppFolder> reloadedFolders)

adjustLayout

protected void adjustLayout()

createAppFoldersPane

protected com.vaadin.ui.Component createAppFoldersPane()

initAppFoldersContextMenu

protected void initAppFoldersContextMenu()

getAppFolderIcon

protected com.vaadin.server.Resource getAppFolderIcon(AppFolder item)

createSearchFoldersPane

protected com.vaadin.ui.Component createSearchFoldersPane()

initSearchFoldersContextMenu

protected void initSearchFoldersContextMenu()

getSearchFolderIcon

protected com.vaadin.server.Resource getSearchFolderIcon(SearchFolder item)

fillTree

protected <T extends Folder> void fillTree(CubaTree<T> tree,
                                           java.util.List<T> folders)

folderDepth

protected int folderDepth(Folder folder)

getFolderParent

protected Folder getFolderParent(Folder folder)

Returns a given folder's parent only if it's not marked as deleted, otherwise there will be an exception, because a folder returns a not null parent, but there is no such item in tree as it's not loaded as separate folder as it's marked as deleted.

Parameters:

folder - a folder to obtain a parent

Returns:

a parent folder

openFolder

protected void openFolder(AbstractSearchFolder folder)

isNeedFoldersTitle

protected boolean isNeedFoldersTitle()

saveFolder

public Folder saveFolder(Folder folder)

removeFolder

public void removeFolder(Folder folder)

getSearchFoldersTree

public com.vaadin.ui.Tree getSearchFoldersTree()

getAppFoldersTree

public com.vaadin.ui.Tree getAppFoldersTree()

getSearchFolders

public java.util.Collection<SearchFolder> getSearchFolders()

getItemClickable

protected boolean getItemClickable(Folder folder)

isItemExpandable

protected boolean isItemExpandable(Folder folder)

setFrame

public void setFrame(Frame frame)

getFrame

public Frame getFrame()