org.primefaces.component.knob.KnobBase Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation
There is a newer version: 14.0.0
/*
 * The MIT License
 *
 * Copyright (c) 2009-2023 PrimeTek Informatics
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.primefaces.component.knob;

import javax.faces.component.UIInput;
import javax.faces.component.behavior.ClientBehaviorHolder;

import org.primefaces.component.api.PrimeClientBehaviorHolder;
import org.primefaces.component.api.Widget;

public abstract class KnobBase extends UIInput implements Widget, ClientBehaviorHolder, PrimeClientBehaviorHolder {

    public static final String COMPONENT_FAMILY = "org.primefaces.component";

    public static final String DEFAULT_RENDERER = "org.primefaces.component.KnobRenderer";

    public enum PropertyKeys {

        widgetVar,
        min,
        max,
        step,
        thickness,
        width,
        height,
        foregroundColor,
        backgroundColor,
        colorTheme,
        disabled,
        showLabel,
        cursor,
        labelTemplate,
        onchange,
        lineCap,
        styleClass
    }

    public KnobBase() {
        setRendererType(DEFAULT_RENDERER);
    }

    @Override
    public String getFamily() {
        return COMPONENT_FAMILY;
    }

    public String getWidgetVar() {
        return (String) getStateHelper().eval(PropertyKeys.widgetVar, null);
    }

    public void setWidgetVar(String widgetVar) {
        getStateHelper().put(PropertyKeys.widgetVar, widgetVar);
    }

    public int getMin() {
        return (Integer) getStateHelper().eval(PropertyKeys.min, 0);
    }

    public void setMin(int min) {
        getStateHelper().put(PropertyKeys.min, min);
    }

    public int getMax() {
        return (Integer) getStateHelper().eval(PropertyKeys.max, 100);
    }

    public void setMax(int max) {
        getStateHelper().put(PropertyKeys.max, max);
    }

    public int getStep() {
        return (Integer) getStateHelper().eval(PropertyKeys.step, 1);
    }

    public void setStep(int step) {
        getStateHelper().put(PropertyKeys.step, step);
    }

    public Float getThickness() {
        return (Float) getStateHelper().eval(PropertyKeys.thickness, null);
    }

    public void setThickness(Float thickness) {
        getStateHelper().put(PropertyKeys.thickness, thickness);
    }

    public Object getWidth() {
        return getStateHelper().eval(PropertyKeys.width, null);
    }

    public void setWidth(Object width) {
        getStateHelper().put(PropertyKeys.width, width);
    }

    public Object getHeight() {
        return getStateHelper().eval(PropertyKeys.height, null);
    }

    public void setHeight(Object height) {
        getStateHelper().put(PropertyKeys.height, height);
    }

    public Object getForegroundColor() {
        return getStateHelper().eval(PropertyKeys.foregroundColor, null);
    }

    public void setForegroundColor(Object foregroundColor) {
        getStateHelper().put(PropertyKeys.foregroundColor, foregroundColor);
    }

    public Object getBackgroundColor() {
        return getStateHelper().eval(PropertyKeys.backgroundColor, null);
    }

    public void setBackgroundColor(Object backgroundColor) {
        getStateHelper().put(PropertyKeys.backgroundColor, backgroundColor);
    }

    public String getColorTheme() {
        return (String) getStateHelper().eval(PropertyKeys.colorTheme, null);
    }

    public void setColorTheme(String colorTheme) {
        getStateHelper().put(PropertyKeys.colorTheme, colorTheme);
    }

    public boolean isDisabled() {
        return (Boolean) getStateHelper().eval(PropertyKeys.disabled, false);
    }

    public void setDisabled(boolean disabled) {
        getStateHelper().put(PropertyKeys.disabled, disabled);
    }

    public boolean isShowLabel() {
        return (Boolean) getStateHelper().eval(PropertyKeys.showLabel, true);
    }

    public void setShowLabel(boolean showLabel) {
        getStateHelper().put(PropertyKeys.showLabel, showLabel);
    }

    public boolean isCursor() {
        return (Boolean) getStateHelper().eval(PropertyKeys.cursor, false);
    }

    public void setCursor(boolean cursor) {
        getStateHelper().put(PropertyKeys.cursor, cursor);
    }

    public String getLabelTemplate() {
        return (String) getStateHelper().eval(PropertyKeys.labelTemplate, "{value}");
    }

    public void setLabelTemplate(String labelTemplate) {
        getStateHelper().put(PropertyKeys.labelTemplate, labelTemplate);
    }

    public String getOnchange() {
        return (String) getStateHelper().eval(PropertyKeys.onchange, null);
    }

    public void setOnchange(String onchange) {
        getStateHelper().put(PropertyKeys.onchange, onchange);
    }

    public String getLineCap() {
        return (String) getStateHelper().eval(PropertyKeys.lineCap, "butt");
    }

    public void setLineCap(String lineCap) {
        getStateHelper().put(PropertyKeys.lineCap, lineCap);
    }

    public String getStyleClass() {
        return (String) getStateHelper().eval(PropertyKeys.styleClass, null);
    }

    public void setStyleClass(String styleClass) {
        getStateHelper().put(PropertyKeys.styleClass, styleClass);
    }
}