org.opencms.ui.A_CmsCustomComponent.java Source code

Introduction

Here is the source code for org.opencms.ui.A_CmsCustomComponent.java

Source

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.ui;

import org.opencms.file.CmsObject;
import org.opencms.main.CmsUIServlet;

import com.vaadin.server.VaadinServlet;
import com.vaadin.ui.CustomComponent;

/**
 * Abstract component class providing access to the OpenCms context.<p>
 */
public abstract class A_CmsCustomComponent extends CustomComponent {

    /** Serail version id. */
    private static final long serialVersionUID = -3826368197794953978L;

    /**
     * Returns the current cms context.<p>
     *
     * @return the current cms context
     */
    public CmsObject getCmsObject() {

        return ((CmsUIServlet) VaadinServlet.getCurrent()).getCmsObject();
    }
}