vaadin-framework/client/src/main/java/com/vaadin/client/ui/composite/CompositeConnector.java

/*
 * 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.client.ui.composite;

import com.google.gwt.dom.client.EventTarget;
import com.google.gwt.user.client.ui.Label;
import com.google.gwt.user.client.ui.Widget;
import com.vaadin.client.ComponentConnector;
import com.vaadin.client.ConnectorHierarchyChangeEvent;
import com.vaadin.client.DirectionalManagedLayout;
import com.vaadin.client.HasComponentsConnector;
import com.vaadin.client.ui.AbstractHasComponentsConnector;
import com.vaadin.client.ui.SimpleManagedLayout;
import com.vaadin.shared.AbstractComponentState;
import com.vaadin.shared.MouseEventDetails;
import com.vaadin.shared.ui.Connect;
import com.vaadin.shared.ui.Connect.LoadStyle;
import com.vaadin.ui.Composite;

/**
 * Connector for the Composite component.
 *
 * @author Vaadin Ltd
 * @since 8.1
 */
@Connect(value = Composite.class, loadStyle = LoadStyle.EAGER)
public class CompositeConnector extends AbstractHasComponentsConnector
        implements SimpleManagedLayout {

    private ComponentConnector childConnector;

    @Override
    protected Widget createWidget() {
        throw new UnsupportedOperationException(
                "Composite has no widget of its own");
    }

    private boolean hasChildConnector() {
        return getChildConnector() != null;
    }

    private ComponentConnector getChildConnector() {
        // Must store the child connector to have it available when removing the
        // connector
        if (childConnector == null && !getChildren().isEmpty()) {
            childConnector = (ComponentConnector) getChildren().get(0);
        }
        return childConnector;
    }

    @Override
    public Widget getWidget() {
        if (!hasChildConnector()) {
            // This happens in doInit for instance when setConnectorId is called
            return new Label("This widget should not end up anywhere ever");
        } else {
            return getChildConnector().getWidget();
        }
    }

    @Override
    public HasComponentsConnector getParent() {
        return (HasComponentsConnector) super.getParent();
    }

    @Override
    public void updateCaption(ComponentConnector component) {
        // Parent might assume that the connector is always a child connector,
        // therefore passing "this" instead of the child connector. The child
        // caption will be returned as getState() returns the child's state.
        getParent().updateCaption(this);
    }

    @Override
    public AbstractComponentState getState() {
        if (!hasChildConnector()) {
            return new AbstractComponentState();
        } else {
            return getChildConnector().getState();
        }
    }

    @Override
    public void onConnectorHierarchyChange(
            ConnectorHierarchyChangeEvent event) {
        // Handled in getChildConnector
    }

    @Override
    protected void sendContextClickEvent(MouseEventDetails details,
            EventTarget eventTarget) {
        // Do nothing, because Composite is not an actual component, and the
        // event must be handled in inner components.
    }

    @Override
    public void layout() {
        // Pass on the layout to the appropriate method in child connector
        if (childConnector instanceof SimpleManagedLayout) {
            ((SimpleManagedLayout) childConnector).layout();
        } else if (childConnector instanceof DirectionalManagedLayout) {
            ((DirectionalManagedLayout) childConnector).layoutHorizontally();
            ((DirectionalManagedLayout) childConnector).layoutVertically();
        } else {
            getLayoutManager().setNeedsMeasureRecursively(childConnector);
        }
    }

    @Override
    public boolean delegateCaptionHandling() {
        if (!hasChildConnector()) {
            return true;
        } else {
            return getChildConnector().delegateCaptionHandling();
        }
    }
}