Package com.vaadin.client

Class ConnectorHierarchyChangeEvent

java.lang.Object

com.google.web.bindery.event.shared.Event<H>

com.google.gwt.event.shared.GwtEvent<H>

com.vaadin.client.communication.AbstractServerConnectorEvent<ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler>

com.vaadin.client.ConnectorHierarchyChangeEvent

public class ConnectorHierarchyChangeEvent
extends AbstractServerConnectorEvent<ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler>

Event for containing data related to a change in the ServerConnector hierarchy. A ConnectorHierarchyChangedEvent is fired when an update from the server has been fully processed and all hierarchy updates have been completed.

Since:

7.0.0

Author:

Vaadin Ltd

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler	Handles connector hierarchy events.

Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent

com.google.gwt.event.shared.GwtEvent.Type<H extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static com.google.gwt.event.shared.GwtEvent.Type<ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler>	TYPE	Type of this event, used by the event bus.

Constructor Summary

Constructors

Constructor	Description
ConnectorHierarchyChangeEvent()

Method Summary

Modifier and Type	Method	Description
void	dispatch(ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler handler)	Sends this event to the given handler.
com.google.gwt.event.shared.GwtEvent.Type<ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler>	getAssociatedType()
List<ComponentConnector>	getOldChildren()	Returns a collection of the old children for the connector.
HasComponentsConnector	getParent()	Returns the HasComponentsConnector for which this event occurred.
void	setConnector(ServerConnector connector)
void	setOldChildren(List<ComponentConnector> oldChildren)	Sets the collection of the old children for the connector.

Methods inherited from class com.vaadin.client.communication.AbstractServerConnectorEvent

getConnector

Methods inherited from class com.google.gwt.event.shared.GwtEvent

assertLive, getSource, isLive, kill, revive

Methods inherited from class com.google.web.bindery.event.shared.Event

setSource, toDebugString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final com.google.gwt.event.shared.GwtEvent.Type<ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler> TYPE

Type of this event, used by the event bus.

Constructor Detail

ConnectorHierarchyChangeEvent

public ConnectorHierarchyChangeEvent()

Method Detail

getOldChildren

public List<ComponentConnector> getOldChildren()

Returns a collection of the old children for the connector. This was the state before the update was received from the server.

Returns:

A collection of old child connectors. Never returns null.

setOldChildren

public void setOldChildren(List<ComponentConnector> oldChildren)

Sets the collection of the old children for the connector.

Parameters:

oldChildren - The old child connectors. Must not be null.

getParent

public HasComponentsConnector getParent()

Returns the HasComponentsConnector for which this event occurred.

Returns:

The HasComponentsConnector whose child collection has changed. Never returns null.

setConnector

public void setConnector(ServerConnector connector)

Overrides:

setConnector in class AbstractServerConnectorEvent<ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler>

dispatch

public void dispatch(ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler handler)

Description copied from class: AbstractServerConnectorEvent

Sends this event to the given handler.

Specified by:

dispatch in class AbstractServerConnectorEvent<ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler>

Parameters:

handler - The handler to dispatch.

getAssociatedType

public com.google.gwt.event.shared.GwtEvent.Type<ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler> getAssociatedType()

Specified by:

getAssociatedType in class com.google.gwt.event.shared.GwtEvent<ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler>