com.gwidgets.api.leaflet.options

Class DivIconOptions.Builder

java.lang.Object

com.gwidgets.api.leaflet.options.DivIconOptions.Builder

Enclosing class:

DivIconOptions

public static class DivIconOptions.Builder
extends Object

The Class Builder.

Constructor Summary

Constructors

Constructor and Description
Builder(String iconUrl) Instantiates a new builder.

Method Summary

Modifier and Type	Method and Description
DivIconOptions.Builder	attribution(String attribution)
DivIconOptions.Builder	bgPos(Point bgPos)
DivIconOptions	build() Builds th DivIconOptions new instance
DivIconOptions.Builder	className(String className) A custom class name to assign to the icon.
DivIconOptions.Builder	html(String html) A custom HTML code to put inside the div element, empty by default.
DivIconOptions.Builder	iconAnchor(Point iconAnchor) The coordinates of the "tip" of the icon (relative to its top left corner).
DivIconOptions.Builder	iconRetinaUrl(String iconRetinaUrl)
DivIconOptions.Builder	iconSize(Point iconSize) Size of the icon in pixels.
DivIconOptions.Builder	pane(String pane)
DivIconOptions.Builder	popUpAnchor(Point popUpAnchor) The coordinates of the point from which popups will "open", relative to the icon anchor.
DivIconOptions.Builder	shadowAnchor(Point shadowAnchor)
DivIconOptions.Builder	shadowRetinaUrl(String shadowRetinaUrl)
DivIconOptions.Builder	shadowSize(Point shadowSize)
DivIconOptions.Builder	shadowUrl(String shadowUrl)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String iconUrl)

Instantiates a new builder. Takes the icon url as a required paramater.

Parameters:

iconUrl - the icon url

Method Detail

iconSize

public DivIconOptions.Builder iconSize(Point iconSize)

Size of the icon in pixels. Can be also set through CSS.

Parameters:

iconSize - the icon size

Returns:

the builder

iconAnchor

public DivIconOptions.Builder iconAnchor(Point iconAnchor)

The coordinates of the "tip" of the icon (relative to its top left corner). The icon will be aligned so that this point is at the marker's geographical location. Centered by default if size is specified, also can be set in CSS with negative margins.

Parameters:

iconAnchor - the icon anchor

Returns:

the builder

popUpAnchor

public DivIconOptions.Builder popUpAnchor(Point popUpAnchor)

The coordinates of the point from which popups will "open", relative to the icon anchor.

Parameters:

popUpAnchor - the pop up anchor

Returns:

the builder

className

public DivIconOptions.Builder className(String className)

A custom class name to assign to the icon. 'leaflet-div-icon' by default.

Parameters:

className - the class name

Returns:

the builder

html

public DivIconOptions.Builder html(String html)

A custom HTML code to put inside the div element, empty by default.

Parameters:

html - the html

Returns:

the builder

bgPos

public DivIconOptions.Builder bgPos(Point bgPos)

iconRetinaUrl

public DivIconOptions.Builder iconRetinaUrl(String iconRetinaUrl)

shadowUrl

public DivIconOptions.Builder shadowUrl(String shadowUrl)

shadowRetinaUrl

public DivIconOptions.Builder shadowRetinaUrl(String shadowRetinaUrl)

shadowSize

public DivIconOptions.Builder shadowSize(Point shadowSize)

shadowAnchor

public DivIconOptions.Builder shadowAnchor(Point shadowAnchor)

pane

public DivIconOptions.Builder pane(String pane)

attribution

public DivIconOptions.Builder attribution(String attribution)

build

public DivIconOptions build()

Builds th DivIconOptions new instance

Returns:

the div icon options