aboutsummaryrefslogtreecommitdiffstats
path: root/server/src/main/java/com/vaadin/ui/ComponentRootSetter.java
blob: fe0a8e6a884e6fa8171d1e434a2ed397e8b2f124 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*
 * Copyright 2000-2018 Vaadin Ltd.
 *
 * 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.vaadin.ui;

import java.io.Serializable;

/**
 * Internal utility class.
 *
 * @since 8.1
 * @author Vaadin Ltd
 */
public class ComponentRootSetter implements Serializable {

    private ComponentRootSetter() {
        // Util methods only
    }

    /**
     * Sets the composition root for the given custom component or composite.
     * <p>
     * For internal use only.
     *
     * @param customComponent
     *            the custom component or composite
     * @param component
     *            the component to assign as composition root
     */
    public static void setRoot(Component customComponent, Component component) {
        if (customComponent instanceof CustomComponent) {
            ((CustomComponent) customComponent).setCompositionRoot(component);
        } else if (customComponent instanceof Composite) {
            ((Composite) customComponent).setCompositionRoot(component);
        } else {
            throw new IllegalArgumentException(
                    "Parameter is of an unsupported type: "
                            + customComponent.getClass().getName());
        }
    }

    /**
     * Checks if the given custom component or composite may accept a root component.
     * <p>
     * For internal use only.
     *
     * @param customComponent
     *            the custom component or composite
     * @return
     * @since 8.4
     *
     */
    public static boolean canSetRoot(Component customComponent) {
        if(customComponent instanceof  CustomComponent) {
            return true;
        }
        if(customComponent instanceof  Composite) {
            return ((Composite)customComponent).getCompositionRoot() == null;
        }
        return false;
    }
}