Package com.storedobject.ui

Class FileViewer

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.grid.Grid<Object>

com.vaadin.flow.component.treegrid.TreeGrid<Object>

com.storedobject.vaadin.DataTreeGrid<Object>

com.storedobject.ui.DataTreeGrid<Object>

com.storedobject.ui.AbstractObjectForest<FileFolder>

com.storedobject.ui.BaseObjectForest<FileFolder>

com.storedobject.ui.ObjectForest<FileFolder>

com.storedobject.ui.ObjectForestBrowser<FileFolder>

com.storedobject.ui.ObjectForestEditor<FileFolder>

com.storedobject.ui.ObjectForestViewer<FileFolder>

com.storedobject.ui.FileViewer

All Implemented Interfaces:

Executable, Reentrant, FilterMethods<FileFolder>, HasLogic, ObjectLoader<FileFolder>, ObjectSearcher<FileFolder>, ObjectSetter<FileFolder>, ObjectsSetter<FileFolder>, ObjectGridData<FileFolder,Object>, ObjectLoader<FileFolder>, Transactional, ChildVisitor<FileFolder,Object>, ClickHandler, CloseableView, ExecutableView, HasColumns<Object>, SupportWindowMode, ValueChangeHandler, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.grid.Grid<Object>>, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<? extends com.vaadin.flow.component.Component>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.grid.Grid<Object>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.grid.Grid<Object>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValue.ValueChangeListener, com.vaadin.flow.data.event.SortEvent.SortNotifier<com.vaadin.flow.component.grid.Grid<Object>,com.vaadin.flow.component.grid.GridSortOrder<Object>>, com.vaadin.flow.data.provider.HasDataGenerators<Object>, com.vaadin.flow.data.provider.HasDataView<Object,Void,com.vaadin.flow.component.grid.dataview.GridDataView<Object>>, com.vaadin.flow.data.provider.HasLazyDataView<Object,Void,com.vaadin.flow.component.grid.dataview.GridLazyDataView<Object>>, com.vaadin.flow.data.provider.HasListDataView<Object,com.vaadin.flow.component.grid.dataview.GridListDataView<Object>>, com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider<Object>, Serializable, Runnable, EventListener, Consumer<FileFolder>

public class FileViewer
extends ObjectForestViewer<FileFolder>
implements CloseableView

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.grid.Grid

com.vaadin.flow.component.grid.Grid.AbstractGridExtension<T>, com.vaadin.flow.component.grid.Grid.Column<T>, com.vaadin.flow.component.grid.Grid.DataCommunicatorBuilder<T,U extends com.vaadin.flow.data.provider.ArrayUpdater>, com.vaadin.flow.component.grid.Grid.MultiSortPriority, com.vaadin.flow.component.grid.Grid.NestedNullBehavior, com.vaadin.flow.component.grid.Grid.SelectionMode, com.vaadin.flow.component.grid.Grid.SpringData, com.vaadin.flow.component.grid.Grid.UpdateQueue

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.storedobject.vaadin.ClickHandler

ClickHandler.ModifiedClickEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.storedobject.vaadin.HasColumns

HasColumns.SOGrid<T>

Field Summary

Fields inherited from class com.storedobject.ui.ObjectForestBrowser

add, audit, buttonPanel, delete, edit, excel, exit, filter, load, report, view

Constructor Summary

Constructors

Constructor	Description
FileViewer(FileFolder root, String caption)
FileViewer(Application application)
FileViewer(Application application, String path)
FileViewer(Application application, String path, String caption)
FileViewer(String path)
FileViewer(String path, String caption)

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.component.Component	createHeader()	You can have a "header row" (as the first row) that covers the whole grid.
ObjectSearchBuilder<FileFolder>	createSearchBuilder(StringList searchColumns, Consumer<ObjectSearchBuilder<FileFolder>> changeConsumer)
String	getColumnCaption(String columnName)	Get the text to display in the header.
static ObjectIterator<? extends StoredObject>	list(StoredObjectUtility.Link<?> link, StoredObject master)
void	load()	Load the instances.

Methods inherited from class com.storedobject.ui.ObjectForestViewer

create, create

Methods inherited from class com.storedobject.ui.ObjectForestEditor

create, create

Methods inherited from class com.storedobject.ui.ObjectForestBrowser

addExtraButtons, canAdd, canDelete, canEdit, clicked, createExtraButtons, filterActions, isActionAllowed, load, load, removeAllowedAction, setSplitView

Methods inherited from class com.storedobject.ui.ObjectForest

getSelected, refreshCurrentNode, selected

Methods inherited from class com.storedobject.ui.BaseObjectForest

addObjectChangedListener, createObjectEditor, createObjectSearcher, getObjectEditor, getObjectSearcher, getViewComponent, isLinkEditingAllowed, removeObjectChangedListener, setAllowLinkEditing, setLogic, setObjectEditor

Methods inherited from class com.storedobject.ui.AbstractObjectForest

deselectChildren, get_Name, getApplication, getCaption, getDataProvider, getDelegatedLoader, getItem, getLogic, getObjectClass, getRoot, getSelectedObjects, hideLink, isColumnSortable, listRoots, loaded, scrollTo, selectChildren, setKeepCache, setObject, setObjects, setObjectSetter, setRoot, setRoots, setRoots, unwrap, visitChildren

Methods inherited from class com.storedobject.ui.DataTreeGrid

scrollTo

Methods inherited from class com.storedobject.vaadin.DataTreeGrid

addConstructedListener, addHierarchyColumn, appendFooter, clearConstructedListeners, createHierarchyColumn, createHTMLHierarchyColumn, getColumnByKey, getColumns, getSOGrid, isColumnReorderingAllowed, setColumnReorderingAllowed, streamConstructedListeners

Methods inherited from class com.vaadin.flow.component.treegrid.TreeGrid

addCollapseListener, addComponentHierarchyColumn, addExpandListener, collapse, collapse, collapse, collapseRecursively, collapseRecursively, createDefaultArrayUpdater, expand, expand, expand, expandRecursively, expandRecursively, getDataCommunicator, getGenericDataView, getItemsWithChildrenRecursively, getLazyDataView, getListDataView, isExpanded, scrollToEnd, scrollToIndex, scrollToIndex, scrollToItem, setColumns, setDataProvider, setDataProvider, setHierarchyColumn, setHierarchyColumn, setItems, setItems, setItems, setItems, setItems, setUniqueKeyDataGenerator

Methods inherited from class com.vaadin.flow.component.grid.Grid

addCellFocusListener, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumnReorderListener, addColumnResizeListener, addColumns, addComponentColumn, addContextMenu, addDataGenerator, addDragEndListener, addDragStartListener, addDropListener, addFirstHeaderRow, addItemClickListener, addItemDoubleClickListener, addSelectionListener, addSortListener, addThemeVariants, addValueProvider, appendFooterRow, appendHeaderRow, asMultiSelect, asSingleSelect, compareMaybeComparables, configureBeanType, createColumn, createColumnId, createEditor, createSortingComparator, deselect, deselectAll, getAriaLabel, getArrayUpdater, getBeanType, getClassNameGenerator, getColumnLayers, getColumnRendering, getDefaultColumnFactory, getDefaultHeaderRow, getDragFilter, getDropFilter, getDropMode, getEditor, getEmptyStateComponent, getEmptyStateText, getFooterRows, getHeaderRows, getNestedNullBehavior, getPageSize, getPartNameGenerator, getPropertySet, getSelectedItems, getSelectionMode, getSelectionModel, getSelectionPreservationMode, getSortOrder, getTooltipPosition, getUniqueKeyProperty, getUniqueKeyProvider, initConnector, insertColumnLayer, isAllRowsVisible, isDetailsVisible, isDetailsVisibleOnClick, isMultiSort, isRowsDraggable, onAttach, onDataProviderChange, onDetach, onEnabledStateChanged, prependFooterRow, prependHeaderRow, recalculateColumnWidths, removeAllColumns, removeAllFooterRows, removeAllHeaderRows, removeColumn, removeColumnByKey, removeColumnLayer, removeColumns, removeFooterRow, removeHeaderRow, removeThemeVariants, scrollToStart, select, setAllRowsVisible, setAriaLabel, setClassNameGenerator, setColumnKey, setColumnOrder, setColumnOrder, setColumnRendering, setColumns, setDefaultMultiSortPriority, setDetailsVisible, setDetailsVisibleOnClick, setDragDataGenerator, setDragFilter, setDropFilter, setDropMode, setEmptyStateComponent, setEmptyStateText, setItemDetailsRenderer, setItems, setItems, setItemSelectableProvider, setItemsPageable, setItemsPageable, setMultiSort, setMultiSort, setMultiSort, setMultiSort, setNestedNullBehavior, setPageSize, setPartNameGenerator, setRowsDraggable, setSelectionDragDetails, setSelectionMode, setSelectionModel, setSelectionPreservationMode, setSortableColumns, setTooltipGenerator, setTooltipPosition, setUniqueKeyProperty, setUniqueKeyProvider, sort, updateSelectionModeOnClient

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface com.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.storedobject.common.Executable

act

Methods inherited from interface com.storedobject.vaadin.ExecutableView

abort, clean, close, createMenuItem, error, execute, execute, getMenuIconName, getMenuItem, getView, invoke, isCloseable, isFullScreen, isHomeView, log, log, message, returnedFrom, run, setClickable, speak, trackValueChange, tray, valueChanged, warning

Methods inherited from interface com.storedobject.core.FilterMethods

getFilterCondition, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setLoadFilter, setViewFilter, setViewFilter

Methods inherited from interface com.vaadin.flow.component.Focusable

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.storedobject.vaadin.HasColumns

addConstructedListener, addItemSelectedListener, addItemsSelectedListener, appendFooter, appendHeader, clearAlerts, clearConstructedListeners, compact, configure, constructed, createColumn, createColumn, createColumn, createColumn, createColumn, createComponentColumn, createDecoratedWindow, createFooters, createHeaders, createHierarchyColumn, createHTMLColumn, createHTMLHierarchyColumn, createView, customizeColumn, customizeRenderer, deselect, deselect, executing, getColumn, getColumnCount, getColumnDetail, getColumnFunction, getColumnHeaderComponent, getColumnMethodName, getColumnNames, getColumnOrder, getColumnSorter, getColumnTemplate, getConfigureButton, getDataClass, getDefinedColumnCount, getFixedColumnWidth, getMenuItem, getObjectRendered, getObjectUnwrapped, getRelativeColumnWidth, getSOGrid, getTextAlign, getView, ignoreCaseForColumnSorting, includeColumn, isColumnFrozen, isColumnResizable, isColumnVisible, prependFooter, prependHeader, refresh, refresh, refresh, removeItemSelectedListener, render, select, select, setCaption, setColumnFrozen, setColumnResizable, setColumnVisible, setMethodHandlerHost, sort, sort, sortOrder, sortOrder, streamConstructedListeners

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider

getTreeData, setItems, setItems, setTreeData

Methods inherited from interface com.vaadin.flow.data.provider.HasLazyDataView

setItems

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.storedobject.ui.ObjectGridData

canSearch, convert, deselect, deselectAll, doLoad, getEntityFilter, getLoadFilter, getObjectCount, getSearchBuilder, getSelectionModel, isAllowAny, isSearchMode, populate, populate, populate, resetSearch, search, search, search, select, setLoadFilter, setObjectConsumer, setObjectConsumer, setSelectionMode, validateFilterCondition

Methods inherited from interface com.storedobject.core.ObjectLoader

applyFilter, canContain, clear, getAllowAny, getLinkType, getMaster, getOrderBy, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, reload, setLinkType, setLinkType, setMaster, setMaster, setOrderBy, setOrderBy

Methods inherited from interface com.storedobject.ui.ObjectLoader

addDataLoadedListener, applyFilterPredicate, clear, get, getCacheLevel, getEffectiveCondition, getFixedFilter, indexOf, load, setExtraFilter, setExtraFilter, setFilter, setFilter, setFixedFilter, setFixedFilter, setFixedFilter, setFixedFilter, size, streamAll, streamFiltered

Methods inherited from interface com.storedobject.core.ObjectSetter

accept, setObject

Methods inherited from interface com.storedobject.common.Reentrant

isReentrant

Methods inherited from interface com.storedobject.vaadin.util.SupportWindowMode

createWindow

Methods inherited from interface com.storedobject.ui.Transactional

commit, execute, getTransactionManager, run, transact, transact, transactControl, transactControl

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Constructor Details

FileViewer

public FileViewer(Application application)

FileViewer

public FileViewer(Application application,
 String path)

FileViewer

public FileViewer(Application application,
 String path,
 String caption)

FileViewer

public FileViewer(String path)

FileViewer

public FileViewer(String path,
 String caption)

FileViewer

public FileViewer(FileFolder root,
 String caption)

Method Details

createSearchBuilder

public ObjectSearchBuilder<FileFolder> createSearchBuilder(StringList searchColumns,
 Consumer<ObjectSearchBuilder<FileFolder>> changeConsumer)

Specified by:

createSearchBuilder in interface ObjectGridData<FileFolder,Object>

createHeader

public com.vaadin.flow.component.Component createHeader()

Description copied from interface: HasColumns

You can have a "header row" (as the first row) that covers the whole grid. Typically, such a row is to show your own buttons or components to customize the grid. The default implementation returns null and thus, no such row is created. (Please note that HasColumns.createHeaders()} is invoked before this method for adding other header rows just above the main header row. This may be used for column grouping etc.)

Specified by:

createHeader in interface HasColumns<Object>

Overrides:

createHeader in class ObjectForestBrowser<FileFolder>

Returns:

Component to be used as the "header row".

load

public void load()

Description copied from interface: ObjectLoader

Load the instances. Current filtering conditions (return value of FilterMethods.getFilterCondition()) including "load filter" if set will be applied. Also, the value returned by ObjectLoader.getAllowAny() will determine whether instanced of the subclasses to be retrieved or not. The order will be determined by the return value of ObjectLoader.getOrderBy(). If "master" is already set, "links" of the "master" will be loaded.

Specified by:

load in interface ObjectLoader<FileFolder>

getColumnCaption

public String getColumnCaption(String columnName)

Description copied from interface: HasColumns

Get the text to display in the header. This will be invoked only if HasColumns.getColumnHeaderComponent(java.lang.String) returns null.

Specified by:

getColumnCaption in interface HasColumns<Object>

Overrides:

getColumnCaption in class AbstractObjectForest<FileFolder>

Parameters:

columnName - Column name

Returns:

Text to display as header. By default, it tries to determine this from the Application Environment.

list

public static ObjectIterator<? extends StoredObject> list(StoredObjectUtility.Link<?> link,
 StoredObject master)