HIContextButton

java.lang.Object
- java.util.Observable
- - com.highsoft.highcharts.core.HIFoundation
  - - com.highsoft.highcharts.common.hichartsclasses.HIContextButton

public class HIContextButton
extends HIFoundation

Constructor Summary

Constructors
Constructor and Description

HIContextButton()

Constructors
Constructor and Description
`HIContextButton()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAlign()`
`java.lang.Number`	`getButtonSpacing()`
`java.lang.String`	`getClassName()`
`java.lang.Boolean`	`getEnabled()`
`java.lang.Number`	`getHeight()`
`java.lang.String`	`getMenuClassName()`
`java.util.ArrayList<java.lang.String>`	`getMenuItems()`
`HIFunction`	`getOnclick()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`java.lang.String`	`getSymbol()`
`HIColor`	`getSymbolFill()`
`java.lang.Number`	`getSymbolSize()`
`HIColor`	`getSymbolStroke()`
`java.lang.Number`	`getSymbolStrokeWidth()`
`java.lang.Number`	`getSymbolX()`
`java.lang.Number`	`getSymbolY()`
`java.lang.String`	`getText()`
`HITheme`	`getTheme()`
`java.lang.String`	`getTitleKey()`
`java.lang.Boolean`	`getUseHTML()`
`java.lang.String`	`getVerticalAlign()`
`java.lang.Number`	`getWidth()`
`java.lang.Number`	`getX()`
`java.lang.Number`	`getY()`
`void`	`setAlign(java.lang.String align)` Alignment for the buttons.
`void`	`setButtonSpacing(java.lang.Number buttonSpacing)` The pixel spacing between buttons.
`void`	`setClassName(java.lang.String className)` The class name of the context button.
`void`	`setEnabled(java.lang.Boolean enabled)` Whether to enable buttons.
`void`	`setHeight(java.lang.Number height)` Pixel height of the buttons.
`void`	`setMenuClassName(java.lang.String menuClassName)` The class name of the menu appearing from the button.
`void`	`setMenuItems(java.util.ArrayList<java.lang.String> menuItems)` A collection of strings pointing to config options for the menu items.
`void`	`setOnclick(HIFunction onclick)` A click handler callback to use on the button directly instead of the popup menu.
`void`	`setSymbol(java.lang.String symbol)` The symbol for the button.
`void`	`setSymbolFill(HIColor symbolFill)` /** * description: See `navigation.buttonOptions.symbolFill`. * demo: * [Blue symbol stroke for one of the buttons](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/navigation/buttonoptions-symbolfill/) defaults: #666666
`void`	`setSymbolSize(java.lang.Number symbolSize)` The pixel size of the symbol on the button.
`void`	`setSymbolStroke(HIColor symbolStroke)` The color of the symbol's stroke or line.
`void`	`setSymbolStrokeWidth(java.lang.Number symbolStrokeWidth)` The pixel stroke width of the symbol on the button.
`void`	`setSymbolX(java.lang.Number symbolX)` The x position of the center of the symbol inside the button.
`void`	`setSymbolY(java.lang.Number symbolY)` The y position of the center of the symbol inside the button.
`void`	`setText(java.lang.String text)` A text string to add to the individual button.
`void`	`setTheme(HITheme theme)` A configuration object for the button theme.
`void`	`setTitleKey(java.lang.String titleKey)` The key to a `lang` option setting that is used for the button's title tooltip.
`void`	`setUseHTML(java.lang.Boolean useHTML)` Whether to use HTML for rendering the button.
`void`	`setVerticalAlign(java.lang.String verticalAlign)` The vertical alignment of the buttons.
`void`	`setWidth(java.lang.Number width)` The pixel width of the button.
`void`	`setX(java.lang.Number x)` The horizontal position of the button relative to the `align` option.
`void`	`setY(java.lang.Number y)` The vertical offset of the button's position relative to its `verticalAlign`.

Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HIContextButton
```
public HIContextButton()
```
- Method Detail
  - getAlign
```
public java.lang.String getAlign()
```
  - getButtonSpacing
```
public java.lang.Number getButtonSpacing()
```
  - getClassName
```
public java.lang.String getClassName()
```
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
  - getHeight
```
public java.lang.Number getHeight()
```
  - getMenuClassName
```
public java.lang.String getMenuClassName()
```
  - getMenuItems
```
public java.util.ArrayList<java.lang.String> getMenuItems()
```
  - getOnclick
```
public HIFunction getOnclick()
```
  - getParams
```
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
```
    Specified by:
    
    getParams in class HIFoundation
  - getSymbol
```
public java.lang.String getSymbol()
```
  - getSymbolFill
```
public HIColor getSymbolFill()
```
  - getSymbolSize
```
public java.lang.Number getSymbolSize()
```
  - getSymbolStroke
```
public HIColor getSymbolStroke()
```
  - getSymbolStrokeWidth
```
public java.lang.Number getSymbolStrokeWidth()
```
  - getSymbolX
```
public java.lang.Number getSymbolX()
```
  - getSymbolY
```
public java.lang.Number getSymbolY()
```
  - getText
```
public java.lang.String getText()
```
  - getTheme
```
public HITheme getTheme()
```
  - getTitleKey
```
public java.lang.String getTitleKey()
```
  - getUseHTML
```
public java.lang.Boolean getUseHTML()
```
  - getVerticalAlign
```
public java.lang.String getVerticalAlign()
```
  - getWidth
```
public java.lang.Number getWidth()
```
  - getX
```
public java.lang.Number getX()
```
  - getY
```
public java.lang.Number getY()
```
  - setAlign
```
public void setAlign(java.lang.String align)
```
    Alignment for the buttons.
    
    defaults:
    
    right
  - setButtonSpacing
```
public void setButtonSpacing(java.lang.Number buttonSpacing)
```
    The pixel spacing between buttons.
    
    defaults:
    
    3
  - setClassName
```
public void setClassName(java.lang.String className)
```
    The class name of the context button.
    
    defaults:
    
    highcharts-contextbutton
  - setEnabled
```
public void setEnabled(java.lang.Boolean enabled)
```
    Whether to enable buttons.
    
    defaults:
    
    true
  - setHeight
```
public void setHeight(java.lang.Number height)
```
    Pixel height of the buttons.
    
    defaults:
    
    28
  - setMenuClassName
```
public void setMenuClassName(java.lang.String menuClassName)
```
    The class name of the menu appearing from the button.
    
    defaults:
    
    highcharts-contextmenu
  - setMenuItems
```
public void setMenuItems(java.util.ArrayList<java.lang.String> menuItems)
```
    A collection of strings pointing to config options for the menu items. The config options are defined in the `menuItemDefinitions` option. By defaults, there is the "View in full screen" and "Print" menu items, plus one menu item for each of the available export types.
    
    defaults:
    
    ["viewFullscreen", "printChart", "separator", "downloadPNG", "downloadJPEG", "downloadPDF", "downloadSVG"]
  - setOnclick
```
public void setOnclick(HIFunction onclick)
```
    A click handler callback to use on the button directly instead of the popup menu.
  - setSymbol
```
public void setSymbol(java.lang.String symbol)
```
    The symbol for the button. Points to a definition function in the `Highcharts.Renderer.symbols` collection. The defaults `menu` function is part of the exporting module. Possible values are "circle", "square", "diamond", "triangle", "triangle-down", "menu", "menuball" or custom shape.
    
    defaults:
    
    menu
  - setSymbolFill
```
public void setSymbolFill(HIColor symbolFill)
```
    /** * description: See `navigation.buttonOptions.symbolFill`. * demo: * [Blue symbol stroke for one of the buttons](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/navigation/buttonoptions-symbolfill/) defaults: #666666
  - setSymbolSize
```
public void setSymbolSize(java.lang.Number symbolSize)
```
    The pixel size of the symbol on the button.
    
    defaults:
    
    14
  - setSymbolStroke
```
public void setSymbolStroke(HIColor symbolStroke)
```
    The color of the symbol's stroke or line.
    
    defaults:
    
    #666666
  - setSymbolStrokeWidth
```
public void setSymbolStrokeWidth(java.lang.Number symbolStrokeWidth)
```
    The pixel stroke width of the symbol on the button.
    
    defaults:
    
    3
  - setSymbolX
```
public void setSymbolX(java.lang.Number symbolX)
```
    The x position of the center of the symbol inside the button.
    
    defaults:
    
    14.5
  - setSymbolY
```
public void setSymbolY(java.lang.Number symbolY)
```
    The y position of the center of the symbol inside the button.
    
    defaults:
    
    13.5
  - setText
```
public void setText(java.lang.String text)
```
    A text string to add to the individual button.
    
    defaults:
    
    null
  - setTheme
```
public void setTheme(HITheme 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.
  - setTitleKey
```
public void setTitleKey(java.lang.String titleKey)
```
    The key to a `lang` option setting that is used for the button's title tooltip. When the key is `contextButtonTitle`, it refers to `lang.contextButtonTitle` that defaultss to "Chart context menu".
    
    defaults:
    
    contextButtonTitle
  - setUseHTML
```
public void setUseHTML(java.lang.Boolean useHTML)
```
    Whether to use HTML for rendering the button. HTML allows for things like inline CSS or image-based icons.
    
    defaults:
    
    false
  - setVerticalAlign
```
public void setVerticalAlign(java.lang.String verticalAlign)
```
    The vertical alignment of the buttons. Can be one of `"top"`, `"middle"` or `"bottom"`.
    
    defaults:
    
    top
  - setWidth
```
public void setWidth(java.lang.Number width)
```
    The pixel width of the button.
    
    defaults:
    
    28
  - setX
```
public void setX(java.lang.Number x)
```
    The horizontal position of the button relative to the `align` option.
    
    defaults:
    
    -10
  - setY
```
public void setY(java.lang.Number y)
```
    The vertical offset of the button's position relative to its `verticalAlign`.
    
    defaults:
    
    0

Class HIContextButton

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

HIContextButton

Method Detail

getAlign

getButtonSpacing

getClassName

getEnabled

getHeight

getMenuClassName

getMenuItems

getOnclick

getParams

getSymbol

getSymbolFill

getSymbolSize

getSymbolStroke

getSymbolStrokeWidth

getSymbolX

getSymbolY

getText

getTheme

getTitleKey

getUseHTML

getVerticalAlign

getWidth

getX

getY

setAlign

setButtonSpacing

setClassName

setEnabled

setHeight

setMenuClassName

setMenuItems

setOnclick

setSymbol

setSymbolFill

setSymbolSize

setSymbolStroke

setSymbolStrokeWidth

setSymbolX

setSymbolY

setText

setTheme

setTitleKey

setUseHTML

setVerticalAlign

setWidth

setX

setY