com.vaadin.flow.component.charts.model.Frame 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;

/**
 * Provides the option to draw a frame around the charts by defining a bottom,
 * front and back panel.
 */
public class Frame extends AbstractConfigurationObject {

    private Back back;
    private Bottom bottom;
    private Side side;
    private Top top;

    public Frame() {
    }

    /**
     * @see #setBack(Back)
     */
    public Back getBack() {
        if (back == null) {
            back = new Back();
        }
        return back;
    }

    /**
     * Defines the back panel of the frame around 3D charts.
     */
    public void setBack(Back back) {
        this.back = back;
    }

    /**
     * @see #setBottom(Bottom)
     */
    public Bottom getBottom() {
        if (bottom == null) {
            bottom = new Bottom();
        }
        return bottom;
    }

    /**
     * The bottom of the frame around a 3D chart.
     */
    public void setBottom(Bottom bottom) {
        this.bottom = bottom;
    }

    /**
     * @see #setSide(Side)
     */
    public Side getSide() {
        if (side == null) {
            side = new Side();
        }
        return side;
    }

    /**
     * 
     * Note: As of v5.0.12, frame.left or frame.right
     * should be used instead.
     * 
     *
     * 
     * The side for the frame around a 3D chart.
     * 
     */
    public void setSide(Side side) {
        this.side = side;
    }

    /**
     * @see #setTop(Top)
     */
    public Top getTop() {
        if (top == null) {
            top = new Top();
        }
        return top;
    }

    /**
     * The top of the frame around a 3D chart.
     */
    public void setTop(Top top) {
        this.top = top;
    }
}