We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.ui.
Class AbstractListing.AbstractListingExtension<T>
- java.lang.Object
-
- com.vaadin.server.AbstractClientConnector
-
- com.vaadin.server.AbstractExtension
-
- com.vaadin.ui.AbstractListing.AbstractListingExtension<T>
-
Type Parameters:
T- the listing item typeAll Implemented Interfaces:
DataGenerator<T>,MethodEventSource,ClientConnector,Extension,Connector,SerializableDirect Known Subclasses:
Enclosing class:
public abstract static class AbstractListing.AbstractListingExtension<T> extends AbstractExtension implements DataGenerator<T>A helper base class for creating extensions for Listing components. This class provides helpers for accessing the underlying parts of the component and its communication mechanism.
See Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener
-
-
Constructor Summary
Constructors Constructor Description AbstractListingExtension()
-
Method Summary
All Methods Modifier and Type Method Description voidextend(AbstractListing<T> listing)Adds this extension to the given parent listing.
protected TgetData(String key)Gets a data object based on its client-side identifier key.
AbstractListing<T>getParent()Gets the parent connector of this connector, or
nullif the connector is not attached to any parent.protected AbstractListingExtensionStategetState()Returns the shared state for this connector.
protected AbstractListingExtensionStategetState(boolean markAsDirty)Returns the shared state for this connector.
protected voidrefresh(T item)A helper method for refreshing the client-side representation of a single data item.
voidremove()Remove this extension from its target.
-
Methods inherited from class com.vaadin.server.AbstractExtension
extend, getSupportedParentType, setParent
-
Methods inherited from class com.vaadin.server.AbstractClientConnector
addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, attach, beforeClientResponse, createState, detach, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.server.ClientConnector
addAttachListener, addDetachListener, attach, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, getUI, 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.data.provider.DataGenerator
destroyAllData, destroyData, generateData, refreshData
-
-
-
-
Method Detail
-
extend
public void extend(AbstractListing<T> listing)Adds this extension to the given parent listing.
Parameters:
listing- the parent component to add to
-
remove
public void remove()Description copied from interface:
ExtensionRemove this extension from its target. After an extension has been removed, it cannot be attached again.
Specified by:
Overrides:
removein classAbstractExtension
-
getData
protected T getData(String key)Gets a data object based on its client-side identifier key.
Parameters:
key- key for data objectReturns:
the data object
-
getParent
public AbstractListing<T> getParent()Description copied from interface:
ConnectorGets the parent connector of this connector, or
nullif the connector is not attached to any parent.Specified by:
getParentin interfaceClientConnectorSpecified by:
getParentin interfaceConnectorOverrides:
getParentin classAbstractExtensionReturns:
the parent connector, or
nullif there is no parent.
-
refresh
protected void refresh(T item)A helper method for refreshing the client-side representation of a single data item.
Parameters:
item- the item to refresh
-
getState
protected AbstractListingExtensionState getState()Description copied from class:
AbstractClientConnectorReturns the shared state for this connector. The shared state object is shared between the server connector and the client connector. Changes are only communicated from the server to the client and not in the other direction.
As a side effect, marks the connector dirty so any changes done to the state will be sent to the client. Use
getState(false)to avoid marking the connector as dirty.Overrides:
getStatein classAbstractClientConnectorReturns:
The shared state for this connector. Never null.
-
getState
protected AbstractListingExtensionState getState(boolean markAsDirty)Description copied from class:
AbstractClientConnectorReturns the shared state for this connector.
Overrides:
getStatein classAbstractClientConnectorParameters:
markAsDirty- true if the connector should automatically be marked dirty, false otherwiseReturns:
The shared state for this connector. Never null.
See Also:
-
-