Package io.jmix.mapsflowui.kit.component.model.style

Class Style

java.lang.Object

io.jmix.mapsflowui.kit.component.model.MapObservableObject

io.jmix.mapsflowui.kit.component.model.style.Style

All Implemented Interfaces:

Serializable

public class Style
extends MapObservableObject

Class for styling features.

Default style for point:

 new Style()
         .withImage(new CircleStyle()
                 .withRadius(5)
                 .withFill(new Fill("rgba(255,255,255,0.4"))
                 .withStroke(new Stroke()
                         .withWidth(1.25)
                         .withColor("#3399CC")));
 

Default style for linestring:

 new Style()
         .withStroke(new Stroke()
                 .withWidth(1.25)
                 .withColor("#3399CC"));
 

Default style for polygon:

 new Style()
         .withFill(new Fill("rgba(255,255,255,0.4)"))
         .withStroke(new Stroke()
                 .withWidth(1.25)
                 .withColor("#3399CC"));
 

For more details see: Style docs

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

MapObservableObject.ObjectChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected Fill	fill
protected ImageStyle	image
protected Stroke	stroke
protected TextStyle	text
protected Integer	zIndex

Fields inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

children, dirty, eventBus, listener, metaProperties, parent, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
Style()

Method Summary

Modifier and Type	Method	Description
static Style	createDefaultStyle()	Creates Style instance with default fill, stroke and image.
Fill	getFill()
ImageStyle	getImage()
Stroke	getStroke()
TextStyle	getText()
protected String	getType()
Integer	getzIndex()
void	setFill(Fill fill)	Sets fill object that describes which color should be used for filling feature.
void	setImage(ImageStyle image)	Sets the image style.
protected void	setParent(MapObservableObject parent)
void	setStroke(Stroke stroke)	Sets stroke style for feature.
void	setText(TextStyle text)	Sets text style for feature.
void	setZIndex(Integer zIndex)	Sets Z-index to style.
Style	withFill(Fill fill)	See setFill(Fill).
Style	withImage(ImageStyle image)	See setImage(ImageStyle)
Style	withStroke(Stroke stroke)	See setStroke(Stroke).
Style	withText(TextStyle text)	See setText(TextStyle).
Style	withZIndex(Integer zIndex)	See setZIndex(Integer).

Methods inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

addChild, addListener, clearRemovedChildren, clearRemovedChildrenInDepth, equals, fireChangeEvent, getChildren, getEventBus, getMetaProperties, getRemovedChildren, getSyncId, hashCode, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setMapObjectChangeListener, setMetaProperty, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

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

Field Details

fill

protected Fill fill

image

protected ImageStyle image

stroke

protected Stroke stroke

text

protected TextStyle text

zIndex

protected Integer zIndex

Constructor Details

Style

public Style()

Method Details

getImage

public ImageStyle getImage()

Returns:

an image style or null if not set

setImage

public void setImage(ImageStyle image)

Sets the image style. The image can contain an icon or can be an instance of RegularShape class.

For more details see: setImage() docs

Parameters:

image - image to set

withImage

public Style withImage(ImageStyle image)

See setImage(ImageStyle)

Parameters:

image - image to set

Returns:

current instance

getFill

public Fill getFill()

Returns:

fill style or null if not set

setFill

public void setFill(Fill fill)

Sets fill object that describes which color should be used for filling feature.

For more details see: setFill() docs

Parameters:

fill - fill to set

withFill

public Style withFill(Fill fill)

See setFill(Fill).

Parameters:

fill - fill to set

Returns:

current instance

getStroke

public Stroke getStroke()

Returns:

stroke style or null if not set

setStroke

public void setStroke(Stroke stroke)

Sets stroke style for feature. It describes line styling: width, color, dash, etc.

For more details see: setStroke() docs

Parameters:

stroke - stroke style

withStroke

public Style withStroke(Stroke stroke)

See setStroke(Stroke).

Parameters:

stroke - stroke style

Returns:

current instance

getText

public TextStyle getText()

setText

public void setText(TextStyle text)

Sets text style for feature. Text style describes how to display text.

For more details see: setText() docs

Parameters:

text - text style

withText

public Style withText(TextStyle text)

See setText(TextStyle).

Parameters:

text - text style

Returns:

current instance

getzIndex

public Integer getzIndex()

setZIndex

public void setZIndex(Integer zIndex)

Sets Z-index to style. It is used to order styles added to the feature.

For more details see: setZIndex() docs

Parameters:

zIndex - z-index to set

withZIndex

public Style withZIndex(Integer zIndex)

See setZIndex(Integer).

Parameters:

zIndex - z-index to set

Returns:

current instance

createDefaultStyle

public static Style createDefaultStyle()

Creates Style instance with default fill, stroke and image.

Returns:

style with defaults

getType

protected String getType()

Specified by:

getType in class MapObservableObject

setParent

protected void setParent(MapObservableObject parent)

Overrides:

setParent in class MapObservableObject