com.vaadin.client.
Class ConnectorMap
- java.lang.Object
-
- com.vaadin.client.ConnectorMap
-
public class ConnectorMap extends Object
-
-
Constructor Summary
Constructors Constructor Description ConnectorMap()
-
Method Summary
All Methods Modifier and Type Method Description void
clear()
Removes all registered connectors.
static ConnectorMap
get(ApplicationConnection applicationConnection)
ComponentConnector[]
getComponentConnectors()
Deprecated.
As of 7.0.1, usegetComponentConnectorsAsJsArray()
for better performance.JsArrayObject<ComponentConnector>
getComponentConnectorsAsJsArray()
ComponentConnector
getConnector(com.google.gwt.dom.client.Element element)
Returns a
ComponentConnector
element by its root element.ComponentConnector
getConnector(com.google.gwt.user.client.ui.Widget widget)
Retrieves the connector whose widget matches the parameter.
ServerConnector
getConnector(String connectorId)
Returns a
ServerConnector
by its id.Collection<? extends ServerConnector>
getConnectors()
Deprecated.
As of 7.0.1, usegetConnectorsAsJsArray()
for improved performance.JsArrayObject<ServerConnector>
getConnectorsAsJsArray()
com.google.gwt.dom.client.Element
getElement(String connectorId)
Gets the main element for the connector with the given id.
boolean
hasConnector(String connectorId)
Checks if a connector with the given id has been registered.
boolean
isConnector(com.google.gwt.user.client.ui.Widget widget)
Tests if the widget is the root widget of a
ComponentConnector
.boolean
isDragAndDropPaintable(String pid)
FIXME: What does this even do and why?
void
registerConnector(String id, ServerConnector connector)
int
size()
void
unregisterConnector(ServerConnector connector)
Unregisters the given connector; always use after removing a connector.
-
-
-
Method Detail
-
get
public static ConnectorMap get(ApplicationConnection applicationConnection)
-
getConnector
public ServerConnector getConnector(String connectorId)
Returns a
ServerConnector
by its id.Parameters:
connectorId
- The connector idReturns:
A connector or null if a connector with the given id has not been registered
-
getConnector
public ComponentConnector getConnector(com.google.gwt.dom.client.Element element)
Returns a
ComponentConnector
element by its root element.Parameters:
element
- Root element of theComponentConnector
Returns:
A connector or null if a connector with the given id has not been registered
-
isDragAndDropPaintable
public boolean isDragAndDropPaintable(String pid)
FIXME: What does this even do and why?
Parameters:
pid
-Returns:
-
hasConnector
public boolean hasConnector(String connectorId)
Checks if a connector with the given id has been registered.
Parameters:
connectorId
- The id to check forReturns:
true if a connector has been registered with the given id, false otherwise
-
clear
public void clear()
Removes all registered connectors.
-
getConnector
public ComponentConnector getConnector(com.google.gwt.user.client.ui.Widget widget)
Retrieves the connector whose widget matches the parameter.
Parameters:
widget
- The widgetReturns:
A connector with widget as its root widget or null if no connector was found
-
registerConnector
public void registerConnector(String id, ServerConnector connector)
-
getElement
public com.google.gwt.dom.client.Element getElement(String connectorId)
Gets the main element for the connector with the given id. The reverse of
getConnectorId(Element)
.Parameters:
connectorId
- the id of the widget whose element is desiredReturns:
the element for the connector corresponding to the id
-
unregisterConnector
public void unregisterConnector(ServerConnector connector)
Unregisters the given connector; always use after removing a connector. This method does not remove the connector from the DOM, but marks the connector so that ApplicationConnection may clean up its references to it. Removing the widget from DOM is component containers responsibility.
Parameters:
connector
- the connector to remove
-
getComponentConnectors
@Deprecated public ComponentConnector[] getComponentConnectors()
Deprecated.As of 7.0.1, usegetComponentConnectorsAsJsArray()
for better performance.Gets all registered
ComponentConnector
instances.Returns:
An array of all registered
ComponentConnector
instances
-
getComponentConnectorsAsJsArray
public JsArrayObject<ComponentConnector> getComponentConnectorsAsJsArray()
-
size
public int size()
-
getConnectors
@Deprecated public Collection<? extends ServerConnector> getConnectors()
Deprecated.As of 7.0.1, usegetConnectorsAsJsArray()
for improved performance.Returns:
-
getConnectorsAsJsArray
public JsArrayObject<ServerConnector> getConnectorsAsJsArray()
-
isConnector
public boolean isConnector(com.google.gwt.user.client.ui.Widget widget)
Tests if the widget is the root widget of a
ComponentConnector
.Parameters:
widget
- The widget to testReturns:
true if the widget is the root widget of a
ComponentConnector
, false otherwise
-
-