com.tcdng.unify.web.ui.widget.AbstractPage 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.HashMap;
import java.util.Map;

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.util.ValueStoreUtils;
import com.tcdng.unify.web.ControllerPathParts;
import com.tcdng.unify.web.ui.PageBean;
import com.tcdng.unify.web.ui.UnifyWebUIErrorConstants;
import com.tcdng.unify.web.ui.widget.panel.AbstractStandalonePanel;
import com.tcdng.unify.web.ui.widget.panel.StandalonePanel;

/**
 * Serves as the base class for a page component.
 * 
 * @author The Code Department
 * @since 1.0
 */
@UplAttributes({
        @UplAttribute(name = "subCaption", type = String.class),
        @UplAttribute(name = "subCaptionBinding", type = String.class),
        @UplAttribute(name = "type", type = String.class, defaultVal = "ui-page"),
        @UplAttribute(name = "remote", type = boolean.class, defaultVal = "false") })
public abstract class AbstractPage extends AbstractStandalonePanel implements Page {

    private Map standalonePanels;

    private Map attributes;

    private ControllerPathParts controllerPathParts;

    @Override
    public String getSubCaption() throws UnifyException {
        String subCaption = null;
        String subCaptionBinding = getUplAttribute(String.class, "subCaptionBinding");
        if (subCaptionBinding != null) {
            subCaption = getStringValue(subCaptionBinding);
        }

        return subCaption != null ? subCaption : getUplAttribute(String.class, "subCaption");
    }

    @Override
    public void setPathParts(ControllerPathParts controllerPathParts) {
        this.controllerPathParts = controllerPathParts;
    }

    @Override
    public String getPathId() {
        if (controllerPathParts != null) {
            return controllerPathParts.getControllerPathId();
        }

        return null;
    }

    @Override
    public String getPathVariable() {
        if (controllerPathParts != null) {
            return controllerPathParts.getPathVariable();
        }

        return null;
    }

    @Override
    public void setPageBean(PageBean pageBean) throws UnifyException {
        setValueStore(ValueStoreUtils.getValueStore(pageBean, null, -1));
        getRequestContextUtil().setContentScrollReset();;
    }

    @Override
    public PageBean getPageBean() throws UnifyException {
        return (PageBean) getValueStore().getValueObject();
    }

    @Override
    public StandalonePanel getStandalonePanel(String name) throws UnifyException {
        if (standalonePanels != null) {
            StandalonePanel standalonePanel = standalonePanels.get(name);
            if (standalonePanel != null) {
                if (!standalonePanel.isSourceInvalidated()) {
                    return standalonePanel;
                }

                standalonePanels.remove(name);
            }
        }

        return null;
    }

    @Override
    public void addStandalonePanel(String name, StandalonePanel standalonePanel) throws UnifyException {
        if (standalonePanels == null) {
            standalonePanels = new HashMap();
        }

        standalonePanels.put(name, standalonePanel);
    }

    @Override
    public StandalonePanel removeStandalonePanel(String name) throws UnifyException {
        if (standalonePanels != null) {
            return standalonePanels.remove(name);
        }

        return null;
    }

    @Override
    public void resolvePageActions(EventHandler[] eventHandlers) throws UnifyException {
        super.resolvePageActions(eventHandlers);
        if (standalonePanels != null && eventHandlers != null) {
            for (StandalonePanel standalonePanel : standalonePanels.values()) {
                standalonePanel.resolvePageActions(eventHandlers);
            }
        }
    }

    @Override
    public Panel getPanelByLongName(String longName) throws UnifyException {
        if (isWidget(longName)) {
            return (Panel) getWidgetByLongName(longName);
        }

        // Fix refresh panels bug #0001
        // Check stand-alone panels
        if (standalonePanels != null) {
            StandalonePanel panel = standalonePanels.get(longName);
            if (panel != null) {
                return panel;
            }

            // Check stand-alone panel widgets
            for (StandalonePanel standalonePanel : standalonePanels.values()) {
                if (standalonePanel.isWidget(longName)) {
                    return (Panel) standalonePanel.getWidgetByLongName(longName);
                }
            }
        }

        throw new UnifyException(UnifyWebUIErrorConstants.PAGE_PANEL_WITH_ID_NOT_FOUND, longName);
    }

    @Override
    public Panel getPanelByShortName(String shortName) throws UnifyException {
        try {
            return (Panel) getWidgetByShortName(shortName);
        } catch (Exception e) {
            throw new UnifyException(UnifyWebUIErrorConstants.PAGE_PANEL_WITH_ID_NOT_FOUND, shortName);
        }
    }

    @Override
    public void setAttribute(String name, Object value) {
        if (attributes == null) {
            attributes = new HashMap();
        }

        attributes.put(name, value);
    }

    @Override
    public Object getAttribute(String name) {
        if (attributes != null) {
            return attributes.get(name);
        }

        return null;
    }

    @Override
    public Object clearAttribute(String name) {
        if (attributes != null) {
            return attributes.remove(name);
        }

        return null;
    }

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

    @Override
    public Widget getWidgetByLongName(String longName) throws UnifyException {
        if (isWidget(longName)) {
            return super.getWidgetByLongName(longName);
        }

        if (standalonePanels != null) {
            StandalonePanel panel = standalonePanels.get(longName);
            if (panel != null) {
                return panel;
            }

            for (StandalonePanel standalonePanel : standalonePanels.values()) {
                if (standalonePanel.isWidget(longName)) {
                   return standalonePanel.getWidgetByLongName(longName);
                }
            }
        }

        throw new UnifyException(UnifyWebUIErrorConstants.WIDGET_WITH_LONGNAME_UNKNOWN, longName, getLongName());
    }

    @Override
    public String getPopupBaseId() throws UnifyException {
        return getPrefixedId("popb_");
    }

    @Override
    public String getPopupWinId() throws UnifyException {
        return getPrefixedId("popw_");
    }

    @Override
    public String getPopupSysId() throws UnifyException {
        return getPrefixedId("pops_");
    }
}