com.tcdng.unify.web.ui.widget.panel.SwitchPanel Maven / Gradle / Ivy

/*
 * 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.panel;

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.core.util.StringUtils;
import com.tcdng.unify.web.ui.widget.AbstractPanel;
import com.tcdng.unify.web.ui.widget.Widget;

/**
 * Switch panels display a single widget content at any time allowing an actor
 * to switch between different contents.
 * 
 * @author The Code Department
 * @since 1.0
 */
@Component("ui-switchpanel")
@UplAttributes({ @UplAttribute(name = "switchHandler", type = String.class) })
public class SwitchPanel extends AbstractPanel {

    private String currentComponent;

    private SwitchPanelHandler switchPanelHandler;

    @Override
    public void onPageConstruct() throws UnifyException {
        super.onPageConstruct();
        String switchHandlerName = getUplAttribute(String.class, "switchHandler");
        if (StringUtils.isNotBlank(switchHandlerName)) {
            switchPanelHandler = (SwitchPanelHandler) getComponent(switchHandlerName);
        }

        for (String longName : getLayoutWidgetLongNames()) {
            Widget widget = getWidgetByLongName(longName);
            if (!widget.isHidden()) {
                currentComponent = widget.getShortName();
                break;
            }
        }
    }

    public void switchContent(String shortName) throws UnifyException {
        if (switchPanelHandler != null) {
            switchPanelHandler.handleSwitchContent(this, shortName, getValueStore(),
                    !shortName.equals(currentComponent));
        }

        currentComponent = shortName;
    }

    public void setSwitchPanelHandler(SwitchPanelHandler switchPanelHandler) {
        this.switchPanelHandler = switchPanelHandler;
    }

    public String getCurrentWidgetShortName() throws UnifyException {
        return currentComponent;
    }

    public Widget getCurrentWidget() throws UnifyException {
        if (currentComponent != null) {
            return getWidgetByShortName(currentComponent);
        }
        return null;
    }
}