Package org.vaadin.addons.componentfactory.leaflet.operations

Class LeafletOperation

java.lang.Object

org.vaadin.addons.componentfactory.leaflet.operations.LeafletOperation

All Implemented Interfaces:

Serializable

public class LeafletOperation
extends Object
implements Serializable

LeafletOperation class contains all pieces of information is required to perform function invocations on client-side e.g. flyTo() on map.

Since:

2020-03-11

Version:

1.0

Author:

Gabor Kokeny Email: kokeny19@gmail.com

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LeafletOperation(Identifiable target, String functionName, Serializable... arguments)	Creates a new operation describing a client-side function call on the given target.

Method Summary

Modifier and Type	Method	Description
String	getArguments()	Returns the operation arguments serialized to JSON.
String	getFunctionName()	Returns the name of the function to invoke on the client side.
String	getLayerId()	Returns the id of the target layer the function is called on.
boolean	isControlOperation()	Returns whether the operation targets a control rather than a layer.

Methods inherited from class java.lang.Object

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

Constructor Details

LeafletOperation

public LeafletOperation(Identifiable target,
 String functionName,
 Serializable... arguments)

Creates a new operation describing a client-side function call on the given target.

Parameters:

target - the client object (layer or control) the function is called on

functionName - the name of the function to invoke

arguments - the arguments passed to the function

Method Details

getLayerId

public String getLayerId()

Returns the id of the target layer the function is called on.

Returns:

the layerId

getFunctionName

public String getFunctionName()

Returns the name of the function to invoke on the client side.

Returns:

the functionName

isControlOperation

public boolean isControlOperation()

Returns whether the operation targets a control rather than a layer.

Returns:

true if the target is a control

getArguments

public String getArguments()

Returns the operation arguments serialized to JSON.

Returns:

the arguments