org.primefaces.component.keyboard.KeyboardBase 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.keyboard;

import org.primefaces.component.api.AbstractPrimeHtmlInputText;
import org.primefaces.component.api.RTLAware;
import org.primefaces.component.api.Widget;

public abstract class KeyboardBase extends AbstractPrimeHtmlInputText implements Widget, RTLAware {

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

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

    public enum PropertyKeys {

        placeholder,
        widgetVar,
        password,
        showMode,
        buttonImage,
        buttonImageOnly,
        effect,
        effectDuration,
        layout,
        layoutTemplate,
        keypadOnly,
        promptLabel,
        closeLabel,
        clearLabel,
        backspaceLabel
    }

    public KeyboardBase() {
        setRendererType(DEFAULT_RENDERER);
    }

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

    public String getPlaceholder() {
        return (String) getStateHelper().eval(PropertyKeys.placeholder, null);
    }

    public void setPlaceholder(String placeholder) {
        getStateHelper().put(PropertyKeys.placeholder, placeholder);
    }

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

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

    public boolean isPassword() {
        return (Boolean) getStateHelper().eval(PropertyKeys.password, false);
    }

    public void setPassword(boolean password) {
        getStateHelper().put(PropertyKeys.password, password);
    }

    public String getShowMode() {
        return (String) getStateHelper().eval(PropertyKeys.showMode, "focus");
    }

    public void setShowMode(String showMode) {
        getStateHelper().put(PropertyKeys.showMode, showMode);
    }

    public String getButtonImage() {
        return (String) getStateHelper().eval(PropertyKeys.buttonImage, null);
    }

    public void setButtonImage(String buttonImage) {
        getStateHelper().put(PropertyKeys.buttonImage, buttonImage);
    }

    public boolean isButtonImageOnly() {
        return (Boolean) getStateHelper().eval(PropertyKeys.buttonImageOnly, false);
    }

    public void setButtonImageOnly(boolean buttonImageOnly) {
        getStateHelper().put(PropertyKeys.buttonImageOnly, buttonImageOnly);
    }

    public String getEffect() {
        return (String) getStateHelper().eval(PropertyKeys.effect, "fadeIn");
    }

    public void setEffect(String effect) {
        getStateHelper().put(PropertyKeys.effect, effect);
    }

    public String getEffectDuration() {
        return (String) getStateHelper().eval(PropertyKeys.effectDuration, null);
    }

    public void setEffectDuration(String effectDuration) {
        getStateHelper().put(PropertyKeys.effectDuration, effectDuration);
    }

    public String getLayout() {
        return (String) getStateHelper().eval(PropertyKeys.layout, "qwerty");
    }

    public void setLayout(String layout) {
        getStateHelper().put(PropertyKeys.layout, layout);
    }

    public String getLayoutTemplate() {
        return (String) getStateHelper().eval(PropertyKeys.layoutTemplate, null);
    }

    public void setLayoutTemplate(String layoutTemplate) {
        getStateHelper().put(PropertyKeys.layoutTemplate, layoutTemplate);
    }

    public boolean isKeypadOnly() {
        return (Boolean) getStateHelper().eval(PropertyKeys.keypadOnly, false);
    }

    public void setKeypadOnly(boolean keypadOnly) {
        getStateHelper().put(PropertyKeys.keypadOnly, keypadOnly);
    }

    public String getPromptLabel() {
        return (String) getStateHelper().eval(PropertyKeys.promptLabel, null);
    }

    public void setPromptLabel(String promptLabel) {
        getStateHelper().put(PropertyKeys.promptLabel, promptLabel);
    }

    public String getCloseLabel() {
        return (String) getStateHelper().eval(PropertyKeys.closeLabel, null);
    }

    public void setCloseLabel(String closeLabel) {
        getStateHelper().put(PropertyKeys.closeLabel, closeLabel);
    }

    public String getClearLabel() {
        return (String) getStateHelper().eval(PropertyKeys.clearLabel, null);
    }

    public void setClearLabel(String clearLabel) {
        getStateHelper().put(PropertyKeys.clearLabel, clearLabel);
    }

    public String getBackspaceLabel() {
        return (String) getStateHelper().eval(PropertyKeys.backspaceLabel, null);
    }

    public void setBackspaceLabel(String backspaceLabel) {
        getStateHelper().put(PropertyKeys.backspaceLabel, backspaceLabel);
    }
}