com.haulmont.cuba.desktop.gui.data.DesktopContainerHelper.java Source code

Introduction

Here is the source code for com.haulmont.cuba.desktop.gui.data.DesktopContainerHelper.java

Source

/*
 * Copyright (c) 2008-2016 Haulmont.
 *
 * 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.haulmont.cuba.desktop.gui.data;

import com.haulmont.cuba.desktop.gui.components.DesktopCheckBox;
import com.haulmont.cuba.desktop.gui.components.DesktopComponent;
import com.haulmont.cuba.desktop.gui.components.DesktopComponent.HasContextHelpClickHandler;
import com.haulmont.cuba.desktop.gui.components.DesktopContainer;
import com.haulmont.cuba.gui.components.Component;
import com.haulmont.cuba.gui.components.Component.HasContextHelp;
import com.haulmont.cuba.gui.components.Field;
import org.apache.commons.lang.StringUtils;

public class DesktopContainerHelper {

    public static boolean mayHaveExternalCaption(Component component) {
        return (component instanceof Field && !(component instanceof DesktopCheckBox));
    }

    public static boolean hasExternalCaption(Component component) {
        if (component instanceof Field && !(component instanceof DesktopCheckBox)) {
            final String caption = ((Field) component).getCaption();
            if (StringUtils.isNotEmpty(caption)) {
                return true;
            }
        }
        return false;
    }

    /**
     * Checks for the presence of component description
     *
     * @param component component to check
     * @return <b>true</b> if the component has a description, and <b>false</b> otherwise
     */
    public static boolean hasExternalDescription(Component component) {
        if (component instanceof Field && !(component instanceof DesktopCheckBox)) {
            final String description = ((Field) component).getDescription();
            if (StringUtils.isNotEmpty(description)) {
                return true;
            }
        }
        return false;
    }

    public static boolean mayHaveExternalContextHelp(Component component) {
        return component instanceof HasContextHelp;
    }

    public static boolean hasExternalContextHelp(Component component) {
        if (component instanceof HasContextHelp) {
            final String contextHelp = ((HasContextHelp) component).getContextHelpText();
            return StringUtils.isNotEmpty(contextHelp) || component instanceof HasContextHelpClickHandler
                    && ((HasContextHelpClickHandler) component).getContextHelpIconClickHandler() != null;
        }
        return false;
    }

    public static void assignContainer(Component component, DesktopContainer container) {
        if (component instanceof DesktopComponent) {
            ((DesktopComponent) component).setContainer(container);
        } else if (component instanceof Component.Wrapper) { // for frame wrappers
            Object wrapped = ((Component.Wrapper) component).getComposition();
            if (wrapped instanceof DesktopComponent) {
                ((DesktopComponent) wrapped).setContainer(container);
            }
        }
    }
}