Package com.vaadin.componentfactory.maps.model

Class ContextButton

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.ContextButton
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class ContextButton extends AbstractConfigurationObject
Options for the export button.
Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • ContextButton

      public ContextButton()

      Constructor for ContextButton.

    • ContextButton

      public ContextButton(Boolean enabled)

      Constructor for ContextButton.

      Parameters:
      enabled - a Boolean object.

    • ContextButton

      public ContextButton(String text)

      Constructor for ContextButton.

      Parameters:
      text - a String object.

  • Method Details

    • getAlign

      public HorizontalAlign getAlign()

      Getter for the field align.

      Returns:
      a HorizontalAlign object.
      See Also:

    • setAlign

      public void setAlign(HorizontalAlign align)
      Alignment for the buttons.

      Defaults to: right

      Parameters:
      align - a HorizontalAlign object.

    • getEnabled

      public Boolean getEnabled()

      Getter for the field enabled.

      Returns:
      a Boolean object.
      See Also:

    • setEnabled

      public void setEnabled(Boolean enabled)
      Whether to enable buttons.

      Defaults to: true

      Parameters:
      enabled - a Boolean object.

    • getHeight

      public Number getHeight()

      Getter for the field height.

      Returns:
      a Number object.
      See Also:

    • setHeight

      public void setHeight(Number height)
      Pixel height of the buttons.

      Defaults to: 20

      Parameters:
      height - a Number object.

    • getSymbol

      public String getSymbol()

      Getter for the field symbol.

      Returns:
      a String object.
      See Also:

    • setSymbol

      public void setSymbol(String symbol)
      The symbol for the button. Points to a definition function in the Highcharts.Renderer.symbols collection. The default exportIcon function is part of the exporting module.

      Defaults to: menu

      Parameters:
      symbol - a String object.

    • getSymbolFill

      public Color getSymbolFill()

      Getter for the field symbolFill.

      Returns:
      a Color object.
      See Also:

    • setSymbolFill

      public void setSymbolFill(Color symbolFill)
      See navigation.buttonOptions => symbolFill.

      Defaults to: #A8BF77

      Parameters:
      symbolFill - a Color object.

    • getSymbolSize

      public Number getSymbolSize()

      Getter for the field symbolSize.

      Returns:
      a Number object.
      See Also:

    • setSymbolSize

      public void setSymbolSize(Number symbolSize)
      The pixel size of the symbol on the button.

      Defaults to: 14

      Parameters:
      symbolSize - a Number object.

    • getSymbolStroke

      public Color getSymbolStroke()

      Getter for the field symbolStroke.

      Returns:
      a Color object.
      See Also:

    • setSymbolStroke

      public void setSymbolStroke(Color symbolStroke)
      The color of the symbol's stroke or line.

      Defaults to: #666

      Parameters:
      symbolStroke - a Color object.

    • getSymbolStrokeWidth

      public Number getSymbolStrokeWidth()

      Getter for the field symbolStrokeWidth.

      Returns:
      a Number object.
      See Also:

    • setSymbolStrokeWidth

      public void setSymbolStrokeWidth(Number symbolStrokeWidth)
      The pixel stroke width of the symbol on the button.

      Defaults to: 1

      Parameters:
      symbolStrokeWidth - a Number object.

    • getSymbolX

      public Number getSymbolX()

      Getter for the field symbolX.

      Returns:
      a Number object.
      See Also:

    • setSymbolX

      public void setSymbolX(Number symbolX)
      The x position of the center of the symbol inside the button.

      Defaults to: 12.5

      Parameters:
      symbolX - a Number object.

    • getSymbolY

      public Number getSymbolY()

      Getter for the field symbolY.

      Returns:
      a Number object.
      See Also:

    • setSymbolY

      public void setSymbolY(Number symbolY)
      The y position of the center of the symbol inside the button.

      Defaults to: 10.5

      Parameters:
      symbolY - a Number object.

    • getText

      public String getText()

      Getter for the field text.

      Returns:
      a String object.
      See Also:

    • setText

      public void setText(String text)
      A text string to add to the individual button.

      Defaults to: null

      Parameters:
      text - a String object.

    • getTheme

      public ButtonTheme getTheme()

      Getter for the field theme.

      Returns:
      a ButtonTheme object.
      See Also:

    • setTheme

      public void setTheme(ButtonTheme theme)
      A configuration object for the button theme. The object accepts SVG properties like stroke-width, stroke and fill. Tri-state button styles are supported by the states.hover and states.select objects.
      Parameters:
      theme - a ButtonTheme object.

    • getVerticalAlign

      public VerticalAlign getVerticalAlign()

      Getter for the field verticalAlign.

      Returns:
      a VerticalAlign object.
      See Also:

    • setVerticalAlign

      public void setVerticalAlign(VerticalAlign verticalAlign)
      The vertical alignment of the buttons. Can be one of "top", "middle" or "bottom".

      Defaults to: top

      Parameters:
      verticalAlign - a VerticalAlign object.

    • getWidth

      public Number getWidth()

      Getter for the field width.

      Returns:
      a Number object.
      See Also:

    • setWidth

      public void setWidth(Number width)
      The pixel width of the button.

      Defaults to: 24

      Parameters:
      width - a Number object.

    • getX

      public Number getX()

      Getter for the field x.

      Returns:
      a Number object.
      See Also:

    • setX

      public void setX(Number x)
      The horizontal position of the button relative to the align option.

      Defaults to: -10

      Parameters:
      x - a Number object.

    • getY

      public Number getY()

      Getter for the field y.

      Returns:
      a Number object.
      See Also:

    • setY

      public void setY(Number y)
      The vertical offset of the button's position relative to its verticalAlign. .

      Defaults to: 0

      Parameters:
      y - a Number object.