info.magnolia.resources.app.workbench

Class ResourcesContainer

java.lang.Object

com.vaadin.data.util.AbstractContainer

info.magnolia.resources.app.workbench.ResourcesContainer

All Implemented Interfaces:

com.vaadin.data.Collapsible, com.vaadin.data.Container, com.vaadin.data.Container.Hierarchical, com.vaadin.data.Container.Indexed, com.vaadin.data.Container.ItemSetChangeNotifier, com.vaadin.data.Container.Ordered, info.magnolia.ui.workbench.container.Refreshable, Serializable

public class ResourcesContainer
extends com.vaadin.data.util.AbstractContainer
implements com.vaadin.data.Container, com.vaadin.data.Container.Indexed, com.vaadin.data.Container.Hierarchical, com.vaadin.data.Collapsible, info.magnolia.ui.workbench.container.Refreshable, com.vaadin.data.Container.ItemSetChangeNotifier

Vaadin hierarchical Container implementation representing a resource ResourceOrigin.

Uses the Resource as itemId.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.data.util.AbstractContainer

com.vaadin.data.util.AbstractContainer.BaseItemSetChangeEvent, com.vaadin.data.util.AbstractContainer.BasePropertySetChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Container.Indexed

com.vaadin.data.Container.Indexed.ItemAddEvent, com.vaadin.data.Container.Indexed.ItemRemoveEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Container

com.vaadin.data.Container.Editor, com.vaadin.data.Container.Filter, com.vaadin.data.Container.Filterable, com.vaadin.data.Container.Hierarchical, com.vaadin.data.Container.Indexed, com.vaadin.data.Container.ItemSetChangeEvent, com.vaadin.data.Container.ItemSetChangeListener, com.vaadin.data.Container.ItemSetChangeNotifier, com.vaadin.data.Container.Ordered, com.vaadin.data.Container.PropertySetChangeEvent, com.vaadin.data.Container.PropertySetChangeListener, com.vaadin.data.Container.PropertySetChangeNotifier, com.vaadin.data.Container.SimpleFilterable, com.vaadin.data.Container.Sortable, com.vaadin.data.Container.Viewer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_PROPERTY_ID
static String	DIRECTORY_PROPERTY_ID
static String	EDITABLE_PROPERTY_ID
static String	FORMAT_PROPERTY_ID
static String	ORIGIN_NAME_PROPERTY_ID
static String	OVERRIDING_PROPERTY_ID
static Object	RESOURCE_NAME
static String	RESOURCE_PATH
static String	ROOT_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
ResourcesContainer(info.magnolia.resourceloader.ResourceOrigin origin, List<String> moduleNames)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addContainerProperty(Object propertyId, Class<?> type, Object defaultValue)
Object	addItem()
com.vaadin.data.Item	addItem(Object itemId)
Object	addItemAfter(Object previousItemId)
com.vaadin.data.Item	addItemAfter(Object previousItemId, Object newItemId)
Object	addItemAt(int index)
com.vaadin.data.Item	addItemAt(int index, Object newItemId)
void	addItemSetChangeListener(com.vaadin.data.Container.ItemSetChangeListener listener)
void	addListener(com.vaadin.data.Container.ItemSetChangeListener listener)
boolean	areChildrenAllowed(Object itemId)
boolean	containsId(Object itemId)
protected void	doCollapse(Object itemId)
protected void	doExpand(Object itemId)
Object	firstItemId()
List<String>	getChildren(Object itemId)
com.vaadin.data.Property<?>	getContainerProperty(Object itemId, Object propertyId)
Collection<String>	getContainerPropertyIds()
Object	getIdByIndex(int index)
com.vaadin.data.Item	getItem(Object itemId)
Collection<String>	getItemIds()
List<String>	getItemIds(int startIndex, int numberOfItems)
String	getParent(Object itemId)
Class<?>	getType(Object propertyId)
boolean	hasChildren(Object itemId)
int	indexOfId(Object itemId)
boolean	isCollapsed(Object itemId)
boolean	isFirstId(Object itemId)
boolean	isLastId(Object itemId)
protected static boolean	isOverriding(info.magnolia.resourceloader.layered.LayeredResource resource)
boolean	isRoot(Object itemId)
Object	lastItemId()
static com.vaadin.data.Item	newItem(info.magnolia.resourceloader.Resource resource)
Object	nextItemId(Object itemId)
Object	prevItemId(Object itemId)
void	refresh()
boolean	removeAllItems()
boolean	removeContainerProperty(Object propertyId)
boolean	removeItem(Object itemId)
void	removeItemSetChangeListener(com.vaadin.data.Container.ItemSetChangeListener listener)
void	removeListener(com.vaadin.data.Container.ItemSetChangeListener listener)
Collection<String>	rootItemIds()
boolean	setChildrenAllowed(Object itemId, boolean areChildrenAllowed)
void	setClasspathResourcesFiltered(boolean classpathResourcesFiltered) Sets whether or not classpath resources should be tentatively filtered based on their registered magnolia modules.
void	setCollapsed(Object itemId, boolean collapsed)
boolean	setParent(Object itemId, Object newParentId)
protected void	showRootsOnly()
int	size()

Methods inherited from class com.vaadin.data.util.AbstractContainer

addListener, addPropertySetChangeListener, fireContainerPropertySetChange, fireContainerPropertySetChange, fireItemSetChange, fireItemSetChange, getItemSetChangeListeners, getListeners, getPropertySetChangeListeners, removeListener, removePropertySetChangeListener, setItemSetChangeListeners, setPropertySetChangeListeners

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_NAME

public static final Object RESOURCE_NAME

ORIGIN_NAME_PROPERTY_ID

public static final String ORIGIN_NAME_PROPERTY_ID

See Also:

Constant Field Values

CONTENT_PROPERTY_ID

public static final String CONTENT_PROPERTY_ID

See Also:

Constant Field Values

OVERRIDING_PROPERTY_ID

public static final String OVERRIDING_PROPERTY_ID

See Also:

Constant Field Values

RESOURCE_PATH

public static final String RESOURCE_PATH

See Also:

Constant Field Values

FORMAT_PROPERTY_ID

public static final String FORMAT_PROPERTY_ID

See Also:

Constant Field Values

DIRECTORY_PROPERTY_ID

public static final String DIRECTORY_PROPERTY_ID

See Also:

Constant Field Values

EDITABLE_PROPERTY_ID

public static final String EDITABLE_PROPERTY_ID

See Also:

Constant Field Values

ROOT_DIRECTORY

public static final String ROOT_DIRECTORY

See Also:

Constant Field Values

Constructor Detail

ResourcesContainer

public ResourcesContainer(info.magnolia.resourceloader.ResourceOrigin origin,
                  List<String> moduleNames)

Method Detail

setClasspathResourcesFiltered

public void setClasspathResourcesFiltered(boolean classpathResourcesFiltered)

Sets whether or not classpath resources should be tentatively filtered based on their registered magnolia modules.

Parameters:

classpathResourcesFiltered - setting this to true only shows classpath resources whose top-level directory is a registered magnolia module; setting this to false shows classpath resources from all classpathUrls (still pre-filtered in ClasspathResourceOrigin).

See Also:

ClasspathResourceOrigin.excludedPackages()

getItem

public com.vaadin.data.Item getItem(Object itemId)

Specified by:

getItem in interface com.vaadin.data.Container

newItem

public static com.vaadin.data.Item newItem(info.magnolia.resourceloader.Resource resource)

isOverriding

protected static boolean isOverriding(info.magnolia.resourceloader.layered.LayeredResource resource)

getContainerPropertyIds

public Collection<String> getContainerPropertyIds()

Specified by:

getContainerPropertyIds in interface com.vaadin.data.Container

getItemIds

public Collection<String> getItemIds()

Specified by:

getItemIds in interface com.vaadin.data.Container

getContainerProperty

public com.vaadin.data.Property<?> getContainerProperty(Object itemId,
                                               Object propertyId)

Specified by:

getContainerProperty in interface com.vaadin.data.Container

addContainerProperty

public boolean addContainerProperty(Object propertyId,
                           Class<?> type,
                           Object defaultValue)
                             throws UnsupportedOperationException

Specified by:

addContainerProperty in interface com.vaadin.data.Container

Throws:

UnsupportedOperationException

removeContainerProperty

public boolean removeContainerProperty(Object propertyId)
                                throws UnsupportedOperationException

Specified by:

removeContainerProperty in interface com.vaadin.data.Container

Throws:

UnsupportedOperationException

getType

public Class<?> getType(Object propertyId)

Specified by:

getType in interface com.vaadin.data.Container

size

public int size()

Specified by:

size in interface com.vaadin.data.Container

containsId

public boolean containsId(Object itemId)

Specified by:

containsId in interface com.vaadin.data.Container

nextItemId

public Object nextItemId(Object itemId)

Specified by:

nextItemId in interface com.vaadin.data.Container.Ordered

prevItemId

public Object prevItemId(Object itemId)

Specified by:

prevItemId in interface com.vaadin.data.Container.Ordered

firstItemId

public Object firstItemId()

Specified by:

firstItemId in interface com.vaadin.data.Container.Ordered

lastItemId

public Object lastItemId()

Specified by:

lastItemId in interface com.vaadin.data.Container.Ordered

isFirstId

public boolean isFirstId(Object itemId)

Specified by:

isFirstId in interface com.vaadin.data.Container.Ordered

isLastId

public boolean isLastId(Object itemId)

Specified by:

isLastId in interface com.vaadin.data.Container.Ordered

indexOfId

public int indexOfId(Object itemId)

Specified by:

indexOfId in interface com.vaadin.data.Container.Indexed

getIdByIndex

public Object getIdByIndex(int index)

Specified by:

getIdByIndex in interface com.vaadin.data.Container.Indexed

getItemIds

public List<String> getItemIds(int startIndex,
                      int numberOfItems)

Specified by:

getItemIds in interface com.vaadin.data.Container.Indexed

getChildren

public List<String> getChildren(Object itemId)

Specified by:

getChildren in interface com.vaadin.data.Container.Hierarchical

getParent

public String getParent(Object itemId)

Specified by:

getParent in interface com.vaadin.data.Container.Hierarchical

rootItemIds

public Collection<String> rootItemIds()

Specified by:

rootItemIds in interface com.vaadin.data.Container.Hierarchical

areChildrenAllowed

public boolean areChildrenAllowed(Object itemId)

Specified by:

areChildrenAllowed in interface com.vaadin.data.Container.Hierarchical

isRoot

public boolean isRoot(Object itemId)

Specified by:

isRoot in interface com.vaadin.data.Container.Hierarchical

hasChildren

public boolean hasChildren(Object itemId)

Specified by:

hasChildren in interface com.vaadin.data.Container.Hierarchical

setCollapsed

public void setCollapsed(Object itemId,
                boolean collapsed)

Specified by:

setCollapsed in interface com.vaadin.data.Collapsible

doExpand

protected void doExpand(Object itemId)

doCollapse

protected void doCollapse(Object itemId)

isCollapsed

public boolean isCollapsed(Object itemId)

Specified by:

isCollapsed in interface com.vaadin.data.Collapsible

showRootsOnly

protected void showRootsOnly()

refresh

public void refresh()

Specified by:

refresh in interface info.magnolia.ui.workbench.container.Refreshable

addItem

public com.vaadin.data.Item addItem(Object itemId)
                             throws UnsupportedOperationException

Specified by:

addItem in interface com.vaadin.data.Container

Throws:

UnsupportedOperationException

addItem

public Object addItem()
               throws UnsupportedOperationException

Specified by:

addItem in interface com.vaadin.data.Container

Throws:

UnsupportedOperationException

removeItem

public boolean removeItem(Object itemId)
                   throws UnsupportedOperationException

Specified by:

removeItem in interface com.vaadin.data.Container

Specified by:

removeItem in interface com.vaadin.data.Container.Hierarchical

Throws:

UnsupportedOperationException

removeAllItems

public boolean removeAllItems()
                       throws UnsupportedOperationException

Specified by:

removeAllItems in interface com.vaadin.data.Container

Throws:

UnsupportedOperationException

addItemAfter

public Object addItemAfter(Object previousItemId)
                    throws UnsupportedOperationException

Specified by:

addItemAfter in interface com.vaadin.data.Container.Ordered

Throws:

UnsupportedOperationException

addItemAfter

public com.vaadin.data.Item addItemAfter(Object previousItemId,
                                Object newItemId)
                                  throws UnsupportedOperationException

Specified by:

addItemAfter in interface com.vaadin.data.Container.Ordered

Throws:

UnsupportedOperationException

addItemAt

public Object addItemAt(int index)
                 throws UnsupportedOperationException

Specified by:

addItemAt in interface com.vaadin.data.Container.Indexed

Throws:

UnsupportedOperationException

addItemAt

public com.vaadin.data.Item addItemAt(int index,
                             Object newItemId)
                               throws UnsupportedOperationException

Specified by:

addItemAt in interface com.vaadin.data.Container.Indexed

Throws:

UnsupportedOperationException

setParent

public boolean setParent(Object itemId,
                Object newParentId)
                  throws UnsupportedOperationException

Specified by:

setParent in interface com.vaadin.data.Container.Hierarchical

Throws:

UnsupportedOperationException

setChildrenAllowed

public boolean setChildrenAllowed(Object itemId,
                         boolean areChildrenAllowed)
                           throws UnsupportedOperationException

Specified by:

setChildrenAllowed in interface com.vaadin.data.Container.Hierarchical

Throws:

UnsupportedOperationException

addItemSetChangeListener

public void addItemSetChangeListener(com.vaadin.data.Container.ItemSetChangeListener listener)

Specified by:

addItemSetChangeListener in interface com.vaadin.data.Container.ItemSetChangeNotifier

Overrides:

addItemSetChangeListener in class com.vaadin.data.util.AbstractContainer

addListener

public void addListener(com.vaadin.data.Container.ItemSetChangeListener listener)

Specified by:

addListener in interface com.vaadin.data.Container.ItemSetChangeNotifier

Overrides:

addListener in class com.vaadin.data.util.AbstractContainer

removeItemSetChangeListener

public void removeItemSetChangeListener(com.vaadin.data.Container.ItemSetChangeListener listener)

Specified by:

removeItemSetChangeListener in interface com.vaadin.data.Container.ItemSetChangeNotifier

Overrides:

removeItemSetChangeListener in class com.vaadin.data.util.AbstractContainer

removeListener

public void removeListener(com.vaadin.data.Container.ItemSetChangeListener listener)

Specified by:

removeListener in interface com.vaadin.data.Container.ItemSetChangeNotifier

Overrides:

removeListener in class com.vaadin.data.util.AbstractContainer