org.opencms.ade.containerpage.client.CmsContainerJso Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-gwt 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

/*
 * 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.ade.containerpage.client;

import org.opencms.ade.containerpage.shared.I_CmsContainer;

import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArray;

/**
 * Javascript overlay type for container objects.
 * 
 * @since 8.0.0
 */
public class CmsContainerJso extends JavaScriptObject implements I_CmsContainer {

    /**
     * Constructor. Overlay types always have protected, zero-argument constructors.

     */
    protected CmsContainerJso() {

        // nothing to do here
    }

    /**
     * Returns the containers of the page.
     * 
     * @return the containers
     */
    public static final native JsArray getContainers() /*-{
                                                                        return $wnd[@org.opencms.ade.containerpage.shared.CmsCntPageData::KEY_CONTAINER_DATA];
                                                                        }-*/;

    /**
     * @see org.opencms.ade.containerpage.shared.I_CmsContainer#getElements()
     */
    public final native String[] getElements() /*-{
                                               return this[@org.opencms.ade.containerpage.shared.CmsCntPageData::JSONKEY_ELEMENTS];
                                               }-*/;

    /**
     * @see org.opencms.ade.containerpage.shared.I_CmsContainer#getMaxElements()
     */
    public final native int getMaxElements() /*-{
                                             return this[@org.opencms.ade.containerpage.shared.CmsCntPageData::JSONKEY_MAXELEMENTS];
                                             }-*/;

    /**
     * @see org.opencms.ade.containerpage.shared.I_CmsContainer#getName()
     */
    public final native String getName() /*-{
                                         return this[@org.opencms.ade.containerpage.shared.CmsCntPageData::JSONKEY_NAME];
                                         }-*/;

    /**
     * @see org.opencms.ade.containerpage.shared.I_CmsContainer#getType()
     */
    public final native String getType() /*-{
                                         return this[@org.opencms.ade.containerpage.shared.CmsCntPageData::JSONKEY_TYPE];
                                         }-*/;

    /**
     * @see org.opencms.ade.containerpage.shared.I_CmsContainer#getWidth()
     */
    public final native int getWidth() /*-{
                                       return this[@org.opencms.ade.containerpage.shared.CmsCntPageData::JSONKEY_WIDTH];
                                       }-*/;

    /**
     * @see org.opencms.ade.containerpage.shared.I_CmsContainer#isDetailOnly()
     */
    public final native boolean isDetailOnly() /*-{
                                               return this[@org.opencms.ade.containerpage.shared.CmsCntPageData::JSONKEY_DETAILONLY];
                                               }-*/;

    /**
     * @see org.opencms.ade.containerpage.shared.I_CmsContainer#isDetailView()
     */
    public final native boolean isDetailView() /*-{
                                               return this[@org.opencms.ade.containerpage.shared.CmsCntPageData::JSONKEY_DETAILVIEW];
                                               }-*/;

    /**
     * @see org.opencms.ade.containerpage.shared.I_CmsContainer#setElements(java.lang.String[])
     */
    public final native void setElements(String[] elements) /*-{
                                                            this[@org.opencms.ade.containerpage.shared.CmsCntPageData::JSONKEY_ELEMENTS] = elements;
                                                            }-*/;
}