com.tcdng.unify.web.ui.widget.AbstractControl 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;

import java.util.Collections;
import java.util.List;

import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.core.annotation.UplAttribute;
import com.tcdng.unify.core.annotation.UplAttributes;
import com.tcdng.unify.core.constant.TriState;
import com.tcdng.unify.core.upl.UplElementReferences;
import com.tcdng.unify.web.ui.DataTransferBlock;
import com.tcdng.unify.web.ui.widget.control.ControlColorMode;

/**
 * Abstract user interface control.
 * 
 * @author The Code Department
 * @since 1.0
 */
@UplAttributes({ @UplAttribute(name = "focus", type = boolean.class),
        @UplAttribute(name = "sortable", type = boolean.class),
        @UplAttribute(name = "required", type = boolean.class, defaultVal = "false"),
        @UplAttribute(name = "layoutColorMode", type = boolean.class, defaultVal = "false") })
public abstract class AbstractControl extends AbstractDataTransferWidget implements Control {

    private TriState required;

    private ControlColorMode colorMode;

    public AbstractControl() {
        required = TriState.CONFORMING;
        colorMode = ControlColorMode.NORMAL;
    }

    @Override
    public String getStyleClass() throws UnifyException {
        if (ControlColorMode.NORMAL.equals(colorMode) || isLayoutColorMode()) {
            return super.getStyleClass();
        }

        return super.getStyleClass() + " " + colorMode.styleClass();
    }

    @Override
    public String getId() throws UnifyException {
        String prefix = getValuePrefix();
        if (prefix != null) {
            return prefix + '.' + super.getId();
        }
        
        return super.getId();
    }

    @Override
    public String getFacadeId() throws UnifyException {
        return getPrefixedId("fac_");
    }

    @Override
    public String getBorderId() throws UnifyException {
        return getId();
    }

    @Override
    public String getNotificationId() throws UnifyException {
        return getPrefixedId("notf_");
    }

    @Override
    public void populate(DataTransferBlock transferBlock) throws UnifyException {
        String binding = getBinding();
        if (binding != null) {
            getValueStore().store(transferBlock.getItemIndex(), binding, transferBlock.getValue());
        }
    }

    @Override
    public boolean setFocus() throws UnifyException {
        return getRequestContextUtil().setFocusOnWidgetId(getId());
    }

    @Override
    public boolean isFocus() throws UnifyException {
        return getUplAttribute(boolean.class, "focus");
    }

    @Override
    public boolean isLayoutColorMode() throws UnifyException {
        return getUplAttribute(boolean.class, "layoutColorMode");
    }

    @Override
    public void setRequired(TriState required) throws UnifyException {
        this.required = required;
    }

    @Override
    public TriState getRequired() throws UnifyException {
        TriState result = getViewDirective().getRequired();
        if (result.isConforming()) {
            result = required;
            if (result.isConforming()) {
                result = TriState.getTriState(getUplAttribute(boolean.class, "required"));
            }
        }

        return result;
    }

    @Override
    public boolean isField() {
        return true;
    }

    @Override
    public void setColorMode(ControlColorMode colorMode) {
        this.colorMode = colorMode;
    }

    @Override
    public ControlColorMode getColorMode() {
        return colorMode;
    }

    @Override
    public boolean isControl() {
        return true;
    }

    @Override
    public boolean isPanel() {
        return false;
    }

    protected List getPageNames(UplElementReferences uer) throws UnifyException {
        if (uer != null) {
            return getPageManager().getPageNames(uer.getLongNames());
        } else {
            return Collections.emptyList();
        }
    }
}