org.opencms.ui.components.CmsExternalLayout Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version


package org.opencms.ui.components;

import org.opencms.ui.shared.components.CmsExternalLayoutState;

import java.util.Collections;
import java.util.Iterator;

import com.vaadin.ui.AbstractComponent;
import com.vaadin.ui.Component;
import com.vaadin.ui.HasComponents;

/**
 * Single component container that can render the given component in any HTML
 * element.
 *
 * @author Risto Yrjänä / Vaadin Ltd.
 */
public class CmsExternalLayout extends AbstractComponent implements HasComponents {

    /** The serial version id. */
    private static final long serialVersionUID = 4970339558483506331L;

    /** The child component. */
    private final Component m_childComponent;

    /**
     * Create a layout that renders the given component to an external HTML element that
     * has the specified id
     *
     * @param divId
     *            id for the target element, cannot be null
     * @param component
     *            component to be rendered, cannot be null
     */
    public CmsExternalLayout(String divId, Component component) {
        if ((divId == null) || (component == null)) {
            throw new IllegalArgumentException("The div id or the child component cannot be null.");
        }

        getState().m_externalComponentId = divId;
        m_childComponent = component;
        m_childComponent.setParent(this);
    }

    /**
     * @see com.vaadin.ui.AbstractComponent#getState()
     */
    @Override
    public CmsExternalLayoutState getState() {

        return (CmsExternalLayoutState)super.getState();
    }

    /**
     * @see com.vaadin.ui.HasComponents#iterator()
     */
    @Override
    public Iterator iterator() {

        return Collections.singleton(m_childComponent).iterator();
    }
}