com.tcdng.unify.web.ui.widget.control.ToggleButton Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018-2023 The Code Department.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.tcdng.unify.web.ui.widget.control;

import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.core.annotation.Component;
import com.tcdng.unify.core.annotation.UplAttribute;
import com.tcdng.unify.core.annotation.UplAttributes;
import com.tcdng.unify.web.ui.widget.AbstractTargetControl;

/**
 * Toggle button with changing text based on binding property state.
 * 
 * @author The Code Department
 * @since 1.0
 */
@Component("ui-togglebutton")
@UplAttributes({ @UplAttribute(name = "toggleBinding", type = String.class, mandatory = true),
        @UplAttribute(name = "onMessageKey", type = String.class, defaultVal = "button.on"),
        @UplAttribute(name = "offMessageKey", type = String.class, defaultVal = "button.off") })
public class ToggleButton extends AbstractTargetControl {

    public String getToggleBinding() throws UnifyException {
        return getUplAttribute(String.class, "toggleBinding");
    }

    public String getOnMessageKey() throws UnifyException {
        return getUplAttribute(String.class, "onMessageKey");
    }

    public String getOffMessageKey() throws UnifyException {
        return getUplAttribute(String.class, "offMessageKey");
    }
}