com.vaadin.flow.component.charts.model.Accessibility Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-charts-flow Show documentation
There is a newer version: 24.5.4
/**
 * Copyright 2000-2024 Vaadin Ltd.
 *
 * This program is available under Vaadin Commercial License and Service Terms.
 *
 * See  {@literal }  for the full
 * license.
 */
package com.vaadin.flow.component.charts.model;

/**
 * 
 * Options for configuring accessibility for the chart. Requires the
 * accessibility
 * module to be loaded. For a description of the module and information on
 * its features, see Highcharts
 * Accessibility.
 * 
 */
public class Accessibility extends AbstractConfigurationObject {

    private Boolean describeSingleSeries;
    private Boolean enabled;
    private KeyboardNavigation keyboardNavigation;
    private String _fn_onTableAnchorClick;
    private String pointDateFormat;
    private String _fn_pointDateFormatter;
    private String _fn_pointDescriptionFormatter;
    private String _fn_screenReaderSectionFormatter;
    private String _fn_seriesDescriptionFormatter;

    public Accessibility() {
    }

    /**
     * @see #setDescribeSingleSeries(Boolean)
     */
    public Boolean getDescribeSingleSeries() {
        return describeSingleSeries;
    }

    /**
     * Whether or not to add series descriptions to charts with a single series.
     * 
     * Defaults to: false
     */
    public void setDescribeSingleSeries(Boolean describeSingleSeries) {
        this.describeSingleSeries = describeSingleSeries;
    }

    public Accessibility(Boolean enabled) {
        this.enabled = enabled;
    }

    /**
     * @see #setEnabled(Boolean)
     */
    public Boolean getEnabled() {
        return enabled;
    }

    /**
     * Enable accessibility features for the chart.
     * 

     * Defaults to: true
     */
    public void setEnabled(Boolean enabled) {
        this.enabled = enabled;
    }

    /**
     * @see #setKeyboardNavigation(KeyboardNavigation)
     */
    public KeyboardNavigation getKeyboardNavigation() {
        if (keyboardNavigation == null) {
            keyboardNavigation = new KeyboardNavigation();
        }
        return keyboardNavigation;
    }

    /**
     * Options for keyboard navigation.
     */
    public void setKeyboardNavigation(KeyboardNavigation keyboardNavigation) {
        this.keyboardNavigation = keyboardNavigation;
    }

    public String getOnTableAnchorClick() {
        return _fn_onTableAnchorClick;
    }

    public void setOnTableAnchorClick(String _fn_onTableAnchorClick) {
        this._fn_onTableAnchorClick = _fn_onTableAnchorClick;
    }

    /**
     * @see #setPointDateFormat(String)
     */
    public String getPointDateFormat() {
        return pointDateFormat;
    }

    /**
     * 

     * Date format to use for points on datetime axes when describing them to
     * screen reader users.
     * 
     * 
     * Defaults to the same format as in tooltip.
     * 
     * 
     * For an overview of the replacement codes, see
     * dateFormat.
     * 
     */
    public void setPointDateFormat(String pointDateFormat) {
        this.pointDateFormat = pointDateFormat;
    }

    public String getPointDateFormatter() {
        return _fn_pointDateFormatter;
    }

    public void setPointDateFormatter(String _fn_pointDateFormatter) {
        this._fn_pointDateFormatter = _fn_pointDateFormatter;
    }

    public String getPointDescriptionFormatter() {
        return _fn_pointDescriptionFormatter;
    }

    public void setPointDescriptionFormatter(
            String _fn_pointDescriptionFormatter) {
        this._fn_pointDescriptionFormatter = _fn_pointDescriptionFormatter;
    }

    public String getScreenReaderSectionFormatter() {
        return _fn_screenReaderSectionFormatter;
    }

    public void setScreenReaderSectionFormatter(
            String _fn_screenReaderSectionFormatter) {
        this._fn_screenReaderSectionFormatter = _fn_screenReaderSectionFormatter;
    }

    public String getSeriesDescriptionFormatter() {
        return _fn_seriesDescriptionFormatter;
    }

    public void setSeriesDescriptionFormatter(
            String _fn_seriesDescriptionFormatter) {
        this._fn_seriesDescriptionFormatter = _fn_seriesDescriptionFormatter;
    }
}