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 Grid.AbstractGridExtension<T>
- java.lang.Object
-
- com.vaadin.server.AbstractClientConnector
-
- com.vaadin.server.AbstractExtension
-
- com.vaadin.ui.AbstractListing.AbstractListingExtension<T>
-
- com.vaadin.ui.Grid.AbstractGridExtension<T>
-
Type Parameters:
T-All Implemented Interfaces:
DataGenerator<T>,MethodEventSource,ClientConnector,Extension,Connector,SerializableDirect Known Subclasses:
public abstract static class Grid.AbstractGridExtension<T> extends AbstractListing.AbstractListingExtension<T>A helper base class for creating extensions for the Grid component.
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 AbstractGridExtension()
-
Method Summary
All Methods Modifier and Type Method Description protected voidaddComponentToGrid(Component c)Adds given component to the connector hierarchy of Grid.
voidextend(AbstractListing<T> grid)Adds this extension to the given parent listing.
protected StringgetInternalIdForColumn(Grid.Column<T,?> column)Returns the internal id for given column.
Grid<T>getParent()Gets the parent connector of this connector, or
nullif the connector is not attached to any parent.protected AbstractGridExtensionStategetState()Returns the shared state for this connector.
protected AbstractGridExtensionStategetState(boolean markAsDirty)Returns the shared state for this connector.
protected voidremoveComponentFromGrid(Component c)Removes given component from the connector hierarchy of Grid.
-
Methods inherited from class com.vaadin.ui.AbstractListing.AbstractListingExtension
getData, refresh, remove
-
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> grid)Description copied from class:
AbstractListing.AbstractListingExtensionAdds this extension to the given parent listing.
Overrides:
extendin classAbstractListing.AbstractListingExtension<T>Parameters:
grid- the parent component to add to
-
addComponentToGrid
protected void addComponentToGrid(Component c)Adds given component to the connector hierarchy of Grid.
Parameters:
c- the component to add
-
removeComponentFromGrid
protected void removeComponentFromGrid(Component c)Removes given component from the connector hierarchy of Grid.
Parameters:
c- the component to remove
-
getParent
public Grid<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 classAbstractListing.AbstractListingExtension<T>Returns:
the parent connector, or
nullif there is no parent.
-
getState
protected AbstractGridExtensionState 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 classAbstractListing.AbstractListingExtension<T>Returns:
The shared state for this connector. Never null.
-
getState
protected AbstractGridExtensionState getState(boolean markAsDirty)Description copied from class:
AbstractClientConnectorReturns the shared state for this connector.
Overrides:
getStatein classAbstractListing.AbstractListingExtension<T>Parameters:
markAsDirty- true if the connector should automatically be marked dirty, false otherwiseReturns:
The shared state for this connector. Never null.
See Also:
-
getInternalIdForColumn
protected String getInternalIdForColumn(Grid.Column<T,?> column)Returns the internal id for given column. This id should not be confused with the user-defined identifier.
Parameters:
column- the columnReturns:
internal id of given column
-
-