com.tcdng.unify.web.ui.widget.panel.TabbedPanel 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 java.util.ArrayList;
import java.util.List;

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.annotation.UplBinding;
import com.tcdng.unify.web.annotation.Action;
import com.tcdng.unify.web.ui.widget.Container;
import com.tcdng.unify.web.ui.widget.Control;
import com.tcdng.unify.web.ui.widget.Widget;

/**
 * Represents a tabbed panel.
 * 
 * @author The Code Department
 * @since 1.0
 */
@Component("ui-tabbedpanel")
@UplBinding("web/panels/upl/tabbedpanel.upl")
@UplAttributes({ @UplAttribute(name = "tabPosition", type = TabPosition.class, defaultVal = "top") })
public class TabbedPanel extends SwitchPanel {

    private String activeTabId;

    @Override
    public void onPageConstruct() throws UnifyException {
        super.onPageConstruct();
        setComponentValueBeanToThis("selectedTabId");
        setDefaultActive();
    }

    @Override
    @Action
    public void switchState() throws UnifyException {
        super.switchState();
        Widget widget = getWidgetByLongName(getPageManager().getLongName(activeTabId));
        if (!widget.isVisible()) {
            widget = setDefaultActive();
        }

        switchContent(widget.getShortName());
    }

    public TabPosition getTabPosition() throws UnifyException {
        return getUplAttribute(TabPosition.class, "tabPosition");
    }

    public String getSelectedTabId() throws UnifyException {
        return getWidgetByShortName("selectedTabId").getId();
    }

    public String getActiveTabId() throws UnifyException {
        return activeTabId;
    }

    public void setActiveTabId(String activeTabPageName) {
        activeTabId = activeTabPageName;
    }
    
    private Widget setDefaultActive() throws UnifyException {
        for (String longName : getLayoutWidgetLongNames()) {
            Widget widget = getWidgetByLongName(longName);
            if (!widget.isHidden() && widget.isVisible()) {
                activeTabId = widget.getId();
                return widget;
            }
        }
        
        // TODO Throw exception here; there must be at least on visible tab
        return null;
    }

    public List getActiveTabExpandedIdList() throws UnifyException {
        Widget widget = getCurrentWidget();
        if (widget instanceof Container) {
            return getPageManager().getPageNames(((Container) widget).getWidgetLongNames());
        }

        List resultList = new ArrayList();
        resultList.add(widget.getId());
        return resultList;
    }

    public List getTabIds() throws UnifyException {
        List resultList = new ArrayList();
        for (String longName : getLayoutWidgetLongNames()) {
            Widget widget = getWidgetByLongName(longName);
            if (!widget.isHidden()) {
                resultList.add(widget.getId());
            }
        }
        return resultList;
    }

    public Control getSelectedTabIdCtrl() throws UnifyException {
        return (Control) getWidgetByShortName("selectedTabId");
    }
}