org.opencms.ui.apps.I_CmsAppUIContext Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (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.apps;
import org.opencms.ui.I_CmsDialogContext;
import org.opencms.ui.I_CmsUpdateListener;
import java.io.Serializable;
import com.vaadin.ui.Button;
import com.vaadin.ui.Component;
/**
* The app ui context. Allows OpenCms workplace apps access to the surrounding UI.
*/
public interface I_CmsAppUIContext extends Serializable {
/**
* Adds the publish button to the toolbar.
*
* @param updateListener the update listener, called after publishing
*
* @return the added button
*/
Button addPublishButton(I_CmsUpdateListener updateListener);
/**
* Adds a toolbar button.
*
* @param button the button to add
*/
void addToolbarButton(Component button);
/**
* Adds a toolbar button to the right hand side.
*
* @param button the button to add
*/
void addToolbarButtonRight(Component button);
/**
* Removes the app's toolbar buttons.
*/
void clearToolbarButtons();
/**
* Enables or removes the default toolbar buttons.
* These are the context menu and the quick launch drop down.
* The default is enabled = true.
*
* @param enabled true to enable the buttons
*/
void enableDefaultToolbarButtons(boolean enabled);
/**
* Returns the app id.
*
* @return the app id
*/
String getAppId();
/**
* Hides the the toolbar.
*/
void hideToolbar();
/**
* Removes the given button from the toolbar.
*
* @param button the button to remove
*/
void removeToolbarButton(Component button);
/**
* Sets the app content component.
*
* @param appContent the app content
*/
void setAppContent(Component appContent);
/**
* Sets the app info component.
*
* @param infoContent the info component
*/
void setAppInfo(Component infoContent);
/**
* Sets the app title.
*
* @param title the app title
*/
void setAppTitle(String title);
/**
* Sets the dialog context for context menu entries.
*
* @param context the dialog context
*/
void setMenuDialogContext(I_CmsDialogContext context);
/**
* Sets the info grid visibility.
*
* @param show true to show the info
*/
void showInfoArea(boolean show);
/**
* Shows the formerly hidden toolbar.
*/
void showToolbar();
/**
* Updates the ui context on site or project changes.
*/
void updateOnChange();
/**
* Updates the displayed user info.
*/
void updateUserInfo();
}