org.opencms.ade.sitemap.client.hoverbar.CmsSitemapHoverbar Maven / Gradle / Ivy
Show all versions of opencms-gwt 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.ade.sitemap.client.hoverbar;
import org.opencms.ade.sitemap.client.control.CmsSitemapController;
import org.opencms.ade.sitemap.client.ui.css.I_CmsImageBundle;
import org.opencms.ade.sitemap.shared.CmsClientSitemapEntry;
import org.opencms.gwt.client.ui.A_CmsHoverHandler;
import org.opencms.gwt.client.ui.CmsListItemWidget;
import org.opencms.gwt.client.ui.CmsPushButton;
import org.opencms.gwt.client.ui.tree.CmsTreeItem;
import org.opencms.util.CmsUUID;
import java.util.Collection;
import java.util.Iterator;
import com.google.gwt.event.dom.client.MouseOutEvent;
import com.google.gwt.event.dom.client.MouseOverEvent;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.event.shared.SimpleEventBus;
import com.google.gwt.user.client.rpc.AsyncCallback;
import com.google.gwt.user.client.ui.FlowPanel;
import com.google.gwt.user.client.ui.Widget;
/**
* Sitemap tree item hover-bar.
*
* @since 8.0.0
*/
public final class CmsSitemapHoverbar extends FlowPanel {
/** The sitemap controller. */
private CmsSitemapController m_controller;
/** Flag if hover bar buttons are enabled. */
private boolean m_enabled;
/** The sitemap entry id. */
private CmsUUID m_entryId;
/** The event bus. */
private SimpleEventBus m_eventBus;
/** Flag indicating if the hoverbar is currently hovered, the mouse cursor is over the bar. */
private boolean m_hovered;
/** Flag to indicate the the hoverbar visibility is locked. */
private boolean m_locked;
/** The entry site path, only used for gallery tree items. */
private String m_sitePath;
/** Flag which controls whether the hover bar should always be visible. */
private boolean m_alwaysVisible;
/**
* Constructor.
*
* @param controller the controller
* @param entryId sitemap entry id
* @param moveable true if in galleries view
* @param contextmenu flag to control whether the context menu should be shown
* @param contextMenuProvider provides items for the context menu
*/
private CmsSitemapHoverbar(
CmsSitemapController controller,
CmsUUID entryId,
boolean moveable,
boolean contextmenu,
I_CmsContextMenuItemProvider contextMenuProvider) {
m_controller = controller;
m_entryId = entryId;
m_eventBus = new SimpleEventBus();
m_enabled = true;
setStyleName(I_CmsImageBundle.INSTANCE.buttonCss().hoverbar());
if (contextmenu) {
add(new CmsHoverbarContextMenuButton(this, contextMenuProvider));
}
if (controller.isEditable() && moveable) {
add(new CmsHoverbarMoveButton(this));
}
}
/**
* Constructor to be used for gallery tree items.
*
* @param controller the controller
* @param entryId sitemap entry id
* @param sitePath the entry site path
* @param contextmenu flag to control whether the context menu should be shown
*/
private CmsSitemapHoverbar(CmsSitemapController controller, CmsUUID entryId, String sitePath, boolean contextmenu) {
this(controller, entryId, false, contextmenu, null);
m_sitePath = sitePath;
}
/**
* Constructor.
*
* @param controller the controller
* @param buttons the buttons to add to the hover bar
*/
private CmsSitemapHoverbar(CmsSitemapController controller, Collection buttons) {
m_controller = controller;
m_eventBus = new SimpleEventBus();
m_enabled = true;
setStyleName(I_CmsImageBundle.INSTANCE.buttonCss().hoverbar());
for (Widget button : buttons) {
add(button);
}
}
/**
* Installs a hover bar for the given item widget.
*
* @param controller the controller
* @param treeItem the item to hover
* @param entryId the entry id
*/
public static void installOn(CmsSitemapController controller, CmsTreeItem treeItem, CmsUUID entryId) {
CmsSitemapHoverbar hoverbar = new CmsSitemapHoverbar(controller, entryId, true, true, null);
installHoverbar(hoverbar, treeItem.getListItemWidget());
}
/**
* Installs a hover bar for the given item widget.
*
* @param controller the controller
* @param treeItem the item to hover
* @param entryId the entry id
* @param movable true if the item should be movable
* @param contextmenu true if the item should have a context menu
* @param menuItemProvider provides items for the context menu
*
* @return the installed hover bar
*/
public static CmsSitemapHoverbar installOn(
CmsSitemapController controller,
CmsTreeItem treeItem,
CmsUUID entryId,
boolean movable,
boolean contextmenu,
I_CmsContextMenuItemProvider menuItemProvider) {
CmsSitemapHoverbar hoverbar = new CmsSitemapHoverbar(
controller,
entryId,
movable,
contextmenu,
menuItemProvider);
installHoverbar(hoverbar, treeItem.getListItemWidget());
return hoverbar;
}
/**
* Installs a hover bar for the given item widget.
*
* @param controller the controller
* @param treeItem the item to hover
* @param entryId the entry id
* @param menuItemProvider the context menu item provider
*/
public static void installOn(
CmsSitemapController controller,
CmsTreeItem treeItem,
CmsUUID entryId,
I_CmsContextMenuItemProvider menuItemProvider) {
CmsSitemapHoverbar hoverbar = new CmsSitemapHoverbar(controller, entryId, true, true, menuItemProvider);
installHoverbar(hoverbar, treeItem.getListItemWidget());
}
/**
* Installs a hover bar for the given item widget.
*
* @param controller the controller
* @param treeItem the item to hover
* @param entryId the entry id
* @param sitePath the entry site path
* @param contextmenu flag to control whether the context menu should be shown
*/
public static void installOn(
CmsSitemapController controller,
CmsTreeItem treeItem,
CmsUUID entryId,
String sitePath,
boolean contextmenu) {
CmsSitemapHoverbar hoverbar = new CmsSitemapHoverbar(controller, entryId, sitePath, contextmenu);
installHoverbar(hoverbar, treeItem.getListItemWidget());
}
/**
* Installs a hover bar for the given item widget.
*
* @param controller the controller
* @param treeItem the item to hover
* @param buttons the buttons
*
* @return the hover bar instance
*/
public static CmsSitemapHoverbar installOn(
CmsSitemapController controller,
CmsTreeItem treeItem,
Collection buttons) {
CmsSitemapHoverbar hoverbar = new CmsSitemapHoverbar(controller, buttons);
installHoverbar(hoverbar, treeItem.getListItemWidget());
return hoverbar;
}
/**
* Installs the given hover bar.
*
* @param hoverbar the hover bar
* @param widget the list item widget
*/
private static void installHoverbar(final CmsSitemapHoverbar hoverbar, CmsListItemWidget widget) {
hoverbar.setVisible(false);
widget.getContentPanel().add(hoverbar);
A_CmsHoverHandler handler = new A_CmsHoverHandler() {
/**
* @see org.opencms.gwt.client.ui.A_CmsHoverHandler#onHoverIn(com.google.gwt.event.dom.client.MouseOverEvent)
*/
@Override
protected void onHoverIn(MouseOverEvent event) {
hoverbar.setHovered(true);
if (hoverbar.isVisible()) {
// prevent show when not needed
return;
}
hoverbar.show();
}
/**
* @see org.opencms.gwt.client.ui.A_CmsHoverHandler#onHoverOut(com.google.gwt.event.dom.client.MouseOutEvent)
*/
@Override
protected void onHoverOut(MouseOutEvent event) {
hoverbar.setHovered(false);
if (!hoverbar.isLocked()) {
hoverbar.hide();
}
}
};
widget.addMouseOutHandler(handler);
widget.addMouseOverHandler(handler);
}
/**
* Adds a new detach event handler.
*
* @param handler the handler to add
*
* @return the handler registration
*/
public HandlerRegistration addHideHandler(I_CmsHoverbarHideHandler handler) {
return m_eventBus.addHandlerToSource(CmsHoverbarHideEvent.getType(), this, handler);
}
/**
* Adds a new attach event handler.
*
* @param handler the handler to add
*
* @return the handler registration
*/
public HandlerRegistration addShowHandler(I_CmsHoverbarShowHandler handler) {
return m_eventBus.addHandlerToSource(CmsHoverbarShowEvent.getType(), this, handler);
}
/**
* Returns the controller.
*
* @return the controller
*/
public CmsSitemapController getController() {
return m_controller;
}
/**
* Returns the sitemap entry.
*
* @return the sitemap entry
*/
public CmsClientSitemapEntry getEntry() {
return m_controller.getEntryById(m_entryId);
}
/**
* Gets the entry id.
*
* @return the entry id
*/
public CmsUUID getId() {
return m_entryId;
}
/**
* Detaches the hover bar.
*/
public void hide() {
m_locked = false;
if (!m_alwaysVisible) {
setVisible(false);
}
m_eventBus.fireEventFromSource(new CmsHoverbarHideEvent(), this);
// CmsDebugLog.getInstance().printLine("detached");
}
/**
* Returns if the bar is hovered.
*
* @return true if hovered
*/
public boolean isHovered() {
return m_hovered;
}
/**
* Makes the hoverbar permanently visible.
*/
public void setAlwaysVisible() {
m_alwaysVisible = true;
setVisible(true);
}
/**
* Sets the buttons of the hoverbar enabled.
*
* @param enable if true the buttons will be enabled
* @param disableMessage message for disabling buttons
*/
public void setEnabled(boolean enable, String disableMessage) {
if (m_enabled && !enable) {
Iterator it = iterator();
while (it.hasNext()) {
Widget w = it.next();
if (w instanceof CmsPushButton) {
((CmsPushButton)w).disable(disableMessage);
}
}
} else if (!m_enabled && enable) {
Iterator it = iterator();
while (it.hasNext()) {
Widget w = it.next();
if (w instanceof CmsPushButton) {
((CmsPushButton)w).enable();
}
}
}
}
/**
* Locks the hoverbar visibility.
*
* @param locked true to lock the hoverbar visibility
*/
public void setLocked(boolean locked) {
m_locked = locked;
}
/**
* Returns if the hoverbar visibility is locked.
*
* @return true if the hoverbar visibility is locked
*/
protected boolean isLocked() {
return m_locked;
}
/**
* Loads the sitemap entry.
*
* @param callback executed when the entry is loaded
*/
protected void loadEntry(AsyncCallback callback) {
CmsClientSitemapEntry entry = getEntry();
if ((entry == null) && (m_sitePath != null)) {
m_controller.loadPath(m_sitePath, true, callback);
} else {
callback.onSuccess(entry);
}
}
/**
* Sets the hovered state.
*
* @param hovered true if hovered
*/
protected void setHovered(boolean hovered) {
m_hovered = hovered;
}
/**
* Shows the hoverbar firing the appropriate event.
*/
protected void show() {
setVisible(true);
m_eventBus.fireEventFromSource(new CmsHoverbarShowEvent(), this);
}
}