info.magnolia.ui.vaadin.integration.contentconnector

Interface ContentConnector

All Known Subinterfaces:

SupportsCreation, SupportsVersions

All Known Implementing Classes:

AbstractContentConnector, DefaultContentConnector, JcrBrowserContentConnector, JcrContentConnector

public interface ContentConnector

Simple stateless component used to bridge arbitrary object by their identifier to a Vaadin Item and vice-versa.

Method Summary

Modifier and Type	Method and Description
boolean	canHandleItem(Object itemId) Check whether current ContentConnector is capable of fetching a Vaadin Item with a specific id.
Object	getDefaultItemId() Get the default item id which for instance could be used as a view selection if no actual item is selected.
com.vaadin.v7.data.Item	getItem(Object itemId) Fetch Vaadin Item by its id.
Object	getItemId(com.vaadin.v7.data.Item item) Get item id.
Object	getItemIdByUrlFragment(String urlFragment) Fetch item id from its string representation.
String	getItemUrlFragment(Object itemId) Convert an item id (arbitrary object) to its string representation which can be appended to a URL fragment and later be used to fetch the item id back.

Method Detail

getItemUrlFragment

String getItemUrlFragment(Object itemId)

Convert an item id (arbitrary object) to its string representation which can be appended to a URL fragment and later be used to fetch the item id back.

Parameters:

itemId - id of an item to be converted to a string representation.

Returns:

string representation of an item id.

See Also:

getItemIdByUrlFragment(java.lang.String).

getItemIdByUrlFragment

Object getItemIdByUrlFragment(String urlFragment)

Fetch item id from its string representation. Used primarily for restoring selection in views from URL fragments.

Parameters:

urlFragment - URL fragment that points to an item.

Returns:

item id that corresponds to the URL fragment.

getDefaultItemId

Object getDefaultItemId()

Get the default item id which for instance could be used as a view selection if no actual item is selected. Most common example of such an item is a root node of the tree hierarchy.

Returns:

default item id.

getItem

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

Fetch Vaadin Item by its id. Such item is not bound to any container and can eventually be used in actions for editing.

Parameters:

itemId - item id.

Returns:

Vaadin Item that corresponds to the id.

getItemId

Object getItemId(com.vaadin.v7.data.Item item)

Get item id.

Parameters:

item - Item id of which is to be returned.

Returns:

id of an item.

canHandleItem

boolean canHandleItem(Object itemId)

Check whether current ContentConnector is capable of fetching a Vaadin Item with a specific id.

Parameters:

itemId - id of a Vaadin Item to look up.

Returns:

true if such a Vaadin Item exists, false - otherwise.