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.client.connectors.
Class AbstractRendererConnector<T>
- java.lang.Object
-
- com.vaadin.client.ui.AbstractConnector
-
- com.vaadin.client.extensions.AbstractExtensionConnector
-
- com.vaadin.client.connectors.AbstractRendererConnector<T>
-
Type Parameters:
T- the presentation type of the rendererAll Implemented Interfaces:
com.google.gwt.event.shared.EventHandler, StateChangeEvent.StateChangeHandler, ServerConnector, Connector, Serializable
Direct Known Subclasses:
ClickableRendererConnector, JavaScriptRendererConnector, ProgressBarRendererConnector, TextRendererConnector, UnsafeHtmlRendererConnector
public abstract class AbstractRendererConnector<T> extends AbstractExtensionConnectorAn abstract base class for renderer connectors. A renderer connector is used to link a client-side
Rendererto a server-sideRenderer. As a connector, it can use the regular Vaadin RPC and shared state mechanism to pass additional state and information between the client and the server. This base class itself only uses the basicSharedStateand no RPC interfaces.Since:
7.4
Author:
Vaadin Ltd
See Also:
-
-
Constructor Summary
Constructors Modifier Constructor and Description protectedAbstractRendererConnector()
-
Method Summary
All Methods Modifier and Type Method and Description protected Renderer<T>createRenderer()Creates a new Renderer instance associated with this renderer connector.
Tdecode(JsonValue value)Decodes the given JSON value into a value of type T so it can be passed to the
renderer.protected voidextend(ServerConnector target)Deprecated.
protected StringgetColumnId(Grid.Column<?,JsonObject> column)Gets the column id for a column.
Renderer<T>getRenderer()Returns the renderer associated with this renderer connector.
protected StringgetRowKey(JsonObject row)Gets the row key for a row object.
-
Methods inherited from class com.vaadin.client.extensions.AbstractExtensionConnector
setParent
-
Methods inherited from class com.vaadin.client.ui.AbstractConnector
addStateChangeHandler, addStateChangeHandler, createState, doInit, ensureHandlerManager, fireEvent, forceStateChange, getChildren, getConnection, getConnectorId, getParent, getResourceUrl, getRpcImplementations, getRpcProxy, getState, getStateType, hasEventListener, init, isEnabled, onStateChanged, onUnregister, registerRpc, removeStateChangeHandler, removeStateChangeHandler, setChildren, unregisterRpc, updateEnabledState
-
-
-
-
Method Detail
-
getRenderer
public Renderer<T> getRenderer()Returns the renderer associated with this renderer connector.
A subclass of AbstractRendererConnector should override this method as shown below. The framework uses
GWT.create(Class)to create a renderer based on the return type of the overridden method, but only ifcreateRenderer()is not overridden as well:public MyRenderer getRenderer() { return (MyRenderer) super.getRenderer(); }Returns:
the renderer bound to this connector
-
createRenderer
protected Renderer<T> createRenderer()Creates a new Renderer instance associated with this renderer connector.
You should typically not override this method since the framework by default generates an implementation that uses
GWT.create(Class)to create a renderer of the same type as returned by the most specific override ofgetRenderer(). If you do override the method, you can't callsuper.createRenderer()since the metadata needed for that implementation is not generated if there's an override of the method.Returns:
a new renderer to be used with this connector
-
decode
public T decode(JsonValue value)Decodes the given JSON value into a value of type T so it can be passed to the
renderer.Parameters:
value- the value to decodeReturns:
the decoded value of
value
-
extend
@Deprecated protected void extend(ServerConnector target)Deprecated.
Description copied from class:
AbstractExtensionConnectorCalled when the extension is attached to its parent. This method is only called once as an extension cannot be moved from one parent to another.
Specified by:
extendin classAbstractExtensionConnectorParameters:
target- The connector this extension extends
-
getRowKey
protected String getRowKey(JsonObject row)Gets the row key for a row object.
In case this renderer wants be able to identify a row in such a way that the server also understands it, the row key is used for that. Rows are identified by unified keys between the client and the server.
Parameters:
row- the row objectReturns:
the row key for the given row
-
getColumnId
protected String getColumnId(Grid.Column<?,JsonObject> column)Gets the column id for a column.
In case this renderer wants be able to identify a column in such a way that the server also understands it, the column id is used for that. Columns are identified by unified ids between the client and the server.
Parameters:
column- the column objectReturns:
the column id for the given column
-
-