|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.vaadin.terminal.gwt.server.DragAndDropService
public class DragAndDropService
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.vaadin.terminal.VariableOwner |
---|
VariableOwner.ErrorEvent |
Constructor Summary | |
---|---|
DragAndDropService(AbstractCommunicationManager manager)
|
Method Summary | |
---|---|
void |
attach()
Notifies the connector that it is connected to an application. |
void |
changeVariables(Object source,
Map<String,Object> variables)
Called when one or more variables handled by the implementing class are changed. |
void |
detach()
Notifies the component that it is detached from the application. |
String |
getConnectorId()
Returns the id for this connector. |
Collection<Extension> |
getExtensions()
Get a read-only collection of all extensions attached to this connector. |
ClientConnector |
getParent()
Gets the parent connector of this connector, or null if the
connector is not attached to any parent. |
Root |
getRoot()
Returns the root this connector is attached to |
RpcManager |
getRpcManager(Class<?> rpcInterface)
Returns the RPC manager instance to use when receiving calls for an RPC interface. |
SharedState |
getState()
Gets the current shared state of the connector. |
Class<? extends SharedState> |
getStateType()
Returns the type of the shared state for this connector |
boolean |
isConnectorEnabled()
Checks if the communicator is enabled. |
boolean |
isEnabled()
Tests if the variable owner is enabled or not. |
boolean |
isImmediate()
Tests if the variable owner is in immediate mode or not. |
void |
removeExtension(Extension extension)
Remove an extension from this connector. |
void |
requestRepaint()
Requests that the connector should be repainted as soon as possible. |
void |
requestRepaintAll()
Causes a repaint of this connector, and all connectors below it. |
List<ClientMethodInvocation> |
retrievePendingRpcCalls()
Returns the list of pending server to client RPC calls and clears the list. |
void |
setParent(ClientConnector parent)
Sets the parent connector of the connector. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DragAndDropService(AbstractCommunicationManager manager)
Method Detail |
---|
public void changeVariables(Object source, Map<String,Object> variables)
VariableOwner
changeVariables
in interface VariableOwner
source
- the Source of the variable change. This is the origin of the
event. For example in Web Adapter this is the request.variables
- the Mapping from variable names to new variable values.public boolean isEnabled()
VariableOwner
Tests if the variable owner is enabled or not. The terminal should not send any variable changes to disabled variable owners.
isEnabled
in interface VariableOwner
true
if the variable owner is enabled,
false
if notpublic boolean isImmediate()
VariableOwner
Tests if the variable owner is in immediate mode or not. Being in immediate mode means that all variable changes are required to be sent back from the terminal immediately when they occur.
Note: VariableOwner
does not include a set-
method for the immediateness property. This is because not all
VariableOwners wish to offer the functionality. Such VariableOwners are
never in the immediate mode, thus they always return false
in VariableOwner.isImmediate()
.
isImmediate
in interface VariableOwner
true
if the component is in immediate mode,
false
if not.public SharedState getState()
Connector
getState
in interface Connector
SharedState
. Never null.public String getConnectorId()
Connector
getConnectorId
in interface Connector
public boolean isConnectorEnabled()
ClientConnector
isConnectorEnabled
in interface ClientConnector
public List<ClientMethodInvocation> retrievePendingRpcCalls()
ClientConnector
retrievePendingRpcCalls
in interface ClientConnector
public RpcManager getRpcManager(Class<?> rpcInterface)
RpcTarget
getRpcManager
in interface RpcTarget
rpcInterface
- interface for which the call was made
public Class<? extends SharedState> getStateType()
ClientConnector
getStateType
in interface ClientConnector
public void requestRepaint()
ClientConnector
requestRepaint
in interface ClientConnector
public ClientConnector getParent()
Connector
null
if the
connector is not attached to any parent.
getParent
in interface Connector
getParent
in interface ClientConnector
null
if there is no parent.public void requestRepaintAll()
ClientConnector
requestRepaintAll
in interface ClientConnector
public void setParent(ClientConnector parent)
ClientConnector
This method automatically calls ClientConnector.attach()
if the connector
becomes attached to the application, regardless of whether it was
attached previously. Conversely, if the parent is null
and the
connector is attached to the application, ClientConnector.detach()
is called for
the connector.
This method is rarely called directly. One of the
ComponentContainer.addComponent(Component)
or
AbstractClientConnector.addExtension(Extension)
methods are
normally used for adding connectors to a parent and they will call this
method implicitly.
It is not possible to change the parent without first setting the parent
to null
.
setParent
in interface ClientConnector
parent
- the parent connectorpublic void attach()
ClientConnector
The caller of this method is ClientConnector.setParent(ClientConnector)
if the
parent is itself already attached to the application. If not, the parent
will call the ClientConnector.attach()
for all its children when it is attached
to the application. This method is always called before the connector's
data is sent to the client-side for the first time.
The attachment logic is implemented in AbstractClientConnector
.
attach
in interface ClientConnector
public void detach()
ClientConnector
The caller of this method is ClientConnector.setParent(ClientConnector)
if the
parent is in the application. When the parent is detached from the
application it is its response to call ClientConnector.detach()
for all the
children and to detach itself from the terminal.
detach
in interface ClientConnector
public Collection<Extension> getExtensions()
ClientConnector
getExtensions
in interface ClientConnector
public void removeExtension(Extension extension)
ClientConnector
removeExtension
in interface ClientConnector
extension
- the extension to remove.public Root getRoot()
ClientConnector
getRoot
in interface ClientConnector
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |