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

Class RegularShape

java.lang.Object

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

io.jmix.mapsflowui.kit.component.model.style.image.ImageStyle

io.jmix.mapsflowui.kit.component.model.style.image.AbstractRegularShape

io.jmix.mapsflowui.kit.component.model.style.image.RegularShape

All Implemented Interfaces:

Serializable

public class RegularShape
extends AbstractRegularShape

Regular shape style for vector features.

For more details see: RegularShape 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 inherited from class io.jmix.mapsflowui.kit.component.model.style.image.AbstractRegularShape

angle, fill, firstRadius, points, radius, secondRadius, stroke

Fields inherited from class io.jmix.mapsflowui.kit.component.model.style.image.ImageStyle

declutterMode, displacement, opacity, rotateWithView, rotation, scale, scaleSize

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

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

Constructor Summary

Constructors

Constructor	Description
RegularShape()

Method Summary

Modifier and Type	Method	Description
Double	getAngle()
DeclutterMode	getDeclutterMode()
Displacement	getDisplacement()
Fill	getFill()
Integer	getFirstRadius()
Integer	getPoints()
Integer	getRadius()
Boolean	getRotateWithView()
Double	getRotation()
Double	getScale()
Size	getScaleSize()
Integer	getSecondRadius()
Stroke	getStroke()
protected String	getType()
void	setAngle(Double angle)	Sets the shape's angle in radians.
void	setDeclutterMode(DeclutterMode declutterMode)	Sets declutter mode.
void	setDisplacement(Displacement displacement)	Sets the displacement of the shape in pixels.
void	setFill(Fill fill)	Sets fill object that describes which color should be used for filling shape.
void	setFirstRadius(Integer firstRadius)	Sets first radius of a star.
void	setPoints(Integer points)	Sets the number of points for stars and regular polygons.
void	setRadius(Integer radius)	Sets the radius of a regular polygon.
void	setRotateWithView(Boolean rotateWithView)	Sets whether to rotate the shape with the map view.
void	setRotation(Double rotation)	Sets the rotation in radians (positive rotation clockwise).
void	setScale(Double scale)	Sets the scale.
void	setScaleSize(Size scaleSize)	Sets the scale size.
void	setSecondRadius(Integer secondRadius)	Sets the second radius of a star.
void	setStroke(Stroke stroke)	Sets stroke style for regular shape.
RegularShape	withAngle(Double angle)	See setAngle(Double).
RegularShape	withDeclutterMode(DeclutterMode declutterMode)	See setDeclutterMode(DeclutterMode).
RegularShape	withDisplacement(Displacement displacement)	See setDisplacement(Displacement).
RegularShape	withFill(Fill fill)	See setFill(Fill).
RegularShape	withFirstRadius(Integer firstRadius)	See setFirstRadius(Integer).
RegularShape	withPoints(Integer points)	See setPoints(Integer).
RegularShape	withRadius(Integer radius)	See setRadius(Integer).
RegularShape	withRotateWithView(Boolean rotateWithView)	See setRotateWithView(Boolean).
RegularShape	withRotation(Double rotation)	See setRotation(Double).
RegularShape	withScale(Double scale)	See setScale(Double).
RegularShape	withScaleSize(Size scaleSize)	See setScaleSize(Size).
RegularShape	withSecondRadius(Integer secondRadius)	See setSecondRadius(Integer).
RegularShape	withStroke(Stroke stroke)	See setStroke(Stroke).

Methods inherited from class io.jmix.mapsflowui.kit.component.model.style.image.ImageStyle

getOpacity, setOpacity

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, setParent, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

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

Constructor Details

RegularShape

public RegularShape()

Method Details

getType

protected String getType()

Specified by:

getType in class MapObservableObject

getFill

public Fill getFill()

Overrides:

getFill in class AbstractRegularShape

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 shape.

For more details see: setFill() docs

Overrides:

setFill in class AbstractRegularShape

Parameters:

fill - fill to set

withFill

public RegularShape withFill(Fill fill)

See setFill(Fill).

Parameters:

fill - fill to set

Returns:

current instance

getPoints

public Integer getPoints()

Overrides:

getPoints in class AbstractRegularShape

Returns:

the number of point or null if not set

setPoints

public void setPoints(Integer points)

Sets the number of points for stars and regular polygons. In case of a polygon, the number of points is the number of sides

Note, points attribute is set only at creation time and cannot be changed at runtime.

For more details see: RegularShape docs

Overrides:

setPoints in class AbstractRegularShape

Parameters:

points - number of points

withPoints

public RegularShape withPoints(Integer points)

See setPoints(Integer).

Parameters:

points - number of points

Returns:

current instance

getRadius

public Integer getRadius()

Overrides:

getRadius in class AbstractRegularShape

Returns:

radius of a regular polygon or null if not set

setRadius

public void setRadius(Integer radius)

Sets the radius of a regular polygon.

Note, radius attribute is set only at creation time and cannot be changed at runtime.

For more details see: RegularShape docs

Overrides:

setRadius in class AbstractRegularShape

Parameters:

radius - radius value

withRadius

public RegularShape withRadius(Integer radius)

See setRadius(Integer).

Parameters:

radius - radius value

Returns:

current instance

getFirstRadius

public Integer getFirstRadius()

Overrides:

getFirstRadius in class AbstractRegularShape

Returns:

first radius of a star or null if not set

setFirstRadius

public void setFirstRadius(Integer firstRadius)

Sets first radius of a star. Ignored if setRadius(Integer) is set.

Note, first radius attribute is set only at creation time and cannot be changed at runtime.

For more details see: RegularShape docs

Overrides:

setFirstRadius in class AbstractRegularShape

Parameters:

firstRadius - first radius value

withFirstRadius

public RegularShape withFirstRadius(Integer firstRadius)

See setFirstRadius(Integer).

Parameters:

firstRadius - first radius value

Returns:

current instance

getSecondRadius

public Integer getSecondRadius()

Overrides:

getSecondRadius in class AbstractRegularShape

Returns:

second radius of a star or null if not set

setSecondRadius

public void setSecondRadius(Integer secondRadius)

Sets the second radius of a star.

Note, second radius attribute is set only at creation time and cannot be changed at runtime.

For more details see: RegularShape docs

Overrides:

setSecondRadius in class AbstractRegularShape

Parameters:

secondRadius - second radius value

withSecondRadius

public RegularShape withSecondRadius(Integer secondRadius)

See setSecondRadius(Integer).

Parameters:

secondRadius - second radius value

Returns:

current instance

getAngle

public Double getAngle()

Overrides:

getAngle in class AbstractRegularShape

Returns:

shape's angle in radians or null if not set

setAngle

public void setAngle(Double angle)

Sets the shape's angle in radians. A value of 0 will have one of the shape's points facing up.

Note, angle attribute is set only at creation time and cannot be changed at runtime.

For more details see: RegularShape docs

Overrides:

setAngle in class AbstractRegularShape

Parameters:

angle - angle value in radians

withAngle

public RegularShape withAngle(Double angle)

See setAngle(Double).

Parameters:

angle - angle value in radians

Returns:

current instance

getStroke

public Stroke getStroke()

Overrides:

getStroke in class AbstractRegularShape

Returns:

stroke style or null if not set

setStroke

public void setStroke(Stroke stroke)

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

For more details see: setStroke() docs

Overrides:

setStroke in class AbstractRegularShape

Parameters:

stroke - stroke style

withStroke

public RegularShape withStroke(Stroke stroke)

See setStroke(Stroke).

Parameters:

stroke - stroke style

Returns:

current instance

getRotateWithView

public Boolean getRotateWithView()

Overrides:

getRotateWithView in class ImageStyle

Returns:

whether the image should get rotated with the map view or null if not set

setRotateWithView

public void setRotateWithView(Boolean rotateWithView)

Sets whether to rotate the shape with the map view. Default value is false.

For more details see: setRotateWithView() docs

Overrides:

setRotateWithView in class ImageStyle

Parameters:

rotateWithView - whether the styled image should be rotated

withRotateWithView

public RegularShape withRotateWithView(Boolean rotateWithView)

See setRotateWithView(Boolean).

Parameters:

rotateWithView - whether the shape should be rotated

Returns:

current instance

getRotation

public Double getRotation()

Overrides:

getRotation in class ImageStyle

Returns:

rotation value or null if not set

setRotation

public void setRotation(Double rotation)

Sets the rotation in radians (positive rotation clockwise). The default value is 0.

For more details see: setRotation() docs

Overrides:

setRotation in class ImageStyle

Parameters:

rotation - rotation value

withRotation

public RegularShape withRotation(Double rotation)

See setRotation(Double).

Parameters:

rotation - rotation value

Returns:

current instance

getScale

public Double getScale()

Overrides:

getScale in class ImageStyle

Returns:

scale value or null if not set

setScale

public void setScale(Double scale)

Sets the scale. Unless two dimensional scaling is required a better result may be obtained with appropriate settings for setRadius(Integer), setFirstRadius(Integer) and setSecondRadius(Integer). The default value is 0.

For more details see: setScale() docs

Overrides:

setScale in class ImageStyle

Parameters:

scale - scale value

withScale

public RegularShape withScale(Double scale)

See setScale(Double).

Parameters:

scale - scale value

Returns:

current instance

getScaleSize

public Size getScaleSize()

Overrides:

getScaleSize in class ImageStyle

Returns:

scale size or null if not set

setScaleSize

public void setScaleSize(Size scaleSize)

Sets the scale size. Note, it takes precedence over the ImageStyle.setScale(Double).

For more details see: setScale() docs

Overrides:

setScaleSize in class ImageStyle

Parameters:

scaleSize - scale size

withScaleSize

public RegularShape withScaleSize(Size scaleSize)

See setScaleSize(Size).

Parameters:

scaleSize - scale size

Returns:

current instance

getDisplacement

public Displacement getDisplacement()

Overrides:

getDisplacement in class ImageStyle

Returns:

displacement value or null if not set

setDisplacement

public void setDisplacement(Displacement displacement)

Sets the displacement of the shape in pixels. Positive values will shift the icon right and up. The default value is [0, 0].

For more details see: setDisplacement() docs

Overrides:

setDisplacement in class ImageStyle

Parameters:

displacement - displacement value

withDisplacement

public RegularShape withDisplacement(Displacement displacement)

See setDisplacement(Displacement).

Parameters:

displacement - displacement value

Returns:

current instance

getDeclutterMode

public DeclutterMode getDeclutterMode()

Overrides:

getDeclutterMode in class ImageStyle

Returns:

declutter mode or null if not set

setDeclutterMode

public void setDeclutterMode(DeclutterMode declutterMode)

Sets declutter mode.

Note, declutter mode attribute is set only at creation time and cannot be changed at runtime.

For more details see: ImageStyle docs

Overrides:

setDeclutterMode in class ImageStyle

Parameters:

declutterMode - declutter mode value

withDeclutterMode

public RegularShape withDeclutterMode(DeclutterMode declutterMode)

See setDeclutterMode(DeclutterMode).

Parameters:

declutterMode - declutter mode value

Returns:

current instance