org.dashbuilder.renderer.RendererSettings Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dashbuilder-displayer-api Show documentation

Dashbuilder Displayer API shared between client and server.

There is a newer version: 7.74.1.Final

Show newest version

package org.dashbuilder.renderer;

import org.jboss.errai.common.client.api.annotations.Portable;

/**
 * Hold Renderer Settings.
 * 
 */
@Portable
public class RendererSettings {

    private final String defaultRenderer;
    private final boolean offline;

    public RendererSettings() {
        this.defaultRenderer = "";
        this.offline = false;
    }


    public RendererSettings(String defaultRenderer, boolean offline) {
        this.defaultRenderer = defaultRenderer;
        this.offline = offline;
    }
    

    /**
     * The UUID of the renderer that should be used by default. 

     * It can be set using org.dashbuilder.renderer.default.
     * 
     * @return The selected default renderer UUID
     */
    public String getDefaultRenderer() {
        return defaultRenderer;
    }

    /**
     * When true renderers that can't work offline are discarded. 

     * It can be set org.dashbuilder.renderer.offline. 
     * 
     * @return The offline flag value
     */
    public boolean isOffline() {
        return offline;
    }

}