/**
    * This file Copyright (c) 2011 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.ui.vaadin.gwt.client.editor.widget.controlbar;
  
  import com.google.gwt.dom.client.Style;
  import com.google.gwt.dom.client.Style.Float;
  import com.google.gwt.event.shared.EventBus;
  import com.google.gwt.user.client.ui.FlowPanel;
  import com.google.gwt.user.client.ui.Label;
  import com.google.gwt.user.client.ui.Widget;
  
  import info.magnolia.ui.vaadin.gwt.client.editor.dom.CmsNode;
  import info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlElement;
  import info.magnolia.ui.vaadin.gwt.client.editor.jsni.JavascriptUtils;
  
  
  /**
   * Base class for horizontal bars with buttons.
   */
  public abstract class AbstractBar extends FlowPanel {
  
      protected final static String ICON_CLASSNAME = "editorIcon";
      protected final static String EDIT_CLASSNAME = "icon-edit";
      protected final static String REMOVE_CLASSNAME = "icon-trash";
      protected final static String ADD_CLASSNAME = "icon-add";
  
      private String workspace;
  
      private String path;
  
      private String label = "";
  
      private final FlowPanel buttonWrapper;
  
      private CmsNode cmsNode;
  
      private FlowPanel primaryButtons;
  
      private FlowPanel secondaryButtons;
  
      private final EventBus eventBus;
  
      private final static String FOCUS_CLASSNAME = "focus";
  
      private final static String CHILD_FOCUS_CLASSNAME = "childFocus";
  
      public AbstractBar(EventBus eventBus, MgnlElement mgnlElement) {
          this.eventBus = eventBus;
  
          this.setCmsNode(mgnlElement);
  
          buttonWrapper = new FlowPanel();
          buttonWrapper.setStylePrimaryName("mgnlEditorBarButtons");
  
          add(buttonWrapper);
  
          if (mgnlElement != null) {
              this.label = mgnlElement.getAttribute("label");
              if (label != null && !label.isEmpty()) {
                  Label areaName = new Label(this.label);
                  // tooltip. Nice to have when area label is truncated because too long.
                  areaName.setTitle(this.label);
                  areaName.setStylePrimaryName("mgnlEditorBarLabel");
  
                  // setStylePrimaryName(..) replaces gwt default css class, in this case gwt-Label
                  add(areaName);
              }
          }
 
         setStyleName("mgnlEditor mgnlEditorBar");
     }
 
     @Override
     public void onAttach() {
         super.onAttach();
     }
 
     protected void setId(String id) {
         getElement().setId(id);
     }
 
     /**
      * Adds this widget to this bar as a button. The default (primary) style applied is
      * <code>mgnlEditorButton</code>. See also <code>editor.css</code>.
      */
     protected void addButton(final Widget button, final Float cssFloat) {
         button.setStylePrimaryName("mgnlEditorButton");
         button.getElement().getStyle().setFloat(cssFloat);
 
         buttonWrapper.add(button);
     }
 
     /**
      * Adds this widget to this bar as a button. The default (primary) style applied is
      * <code>mgnlEditorButton</code>. See also <code>editor.css</code>.
      */
     protected void addSecondaryButton(final Widget button) {
         if (secondaryButtons == null) {
             secondaryButtons = new FlowPanel();
             secondaryButtons.setStylePrimaryName("mgnlEditorBarSecondaryButtons");
             buttonWrapper.add(secondaryButtons);
         }
         secondaryButtons.add(button);
     }
 
     /**
      * Adds this widget to this bar as a button. The default (primary) style applied is
      * <code>mgnlEditorButton</code>. See also <code>editor.css</code>.
      */
     protected void addPrimaryButton(final Widget button) {
         if (primaryButtons == null) {
             primaryButtons = new FlowPanel();
             primaryButtons.setStylePrimaryName("mgnlEditorBarPrimaryButtons");
             buttonWrapper.add(primaryButtons);
         }
 
         primaryButtons.add(button);
     }
 
     /**
      * Adds this widget to this bar as a button. It allows overriding the default (primary) style
      * applied <code>mgnlEditorButton</code>. See also <code>editor.css</code>.
      */
     protected void addButton(final Widget button, final Float cssFloat, final String primaryStyleName) {
         if (JavascriptUtils.isEmpty(primaryStyleName)) {
             addButton(button, cssFloat);
             return;
         }
         button.setStylePrimaryName(primaryStyleName);
         button.getElement().getStyle().setFloat(cssFloat);
 
         buttonWrapper.add(button);
     }
 
     /**
      * Shorthand for <code>getElement().getStyle()</code>.
      * @return the element's underlying {@link Style}. You can use this object to manipulate the css
      * style attribute of this bar widget.
      */
     protected Style getStyle() {
         return getElement().getStyle();
     }
 
 
 
     public void toggleVisible() {
         setVisible(!isVisible());
     }
 
 
     public void setCmsNode(CmsNode cmsNode) {
         this.cmsNode = cmsNode;
     }
 
     public CmsNode getCmsNode() {
         return cmsNode;
     }
 
     public void toggleButtons(boolean visible) {
         CmsNode parent = cmsNode.getParent();
         if (parent != null) {
             for (CmsNode component : parent.getComponents()) {
                 component.asMgnlElement().getControlBar().primaryButtons.setVisible(visible);
                 component.asMgnlElement().getControlBar().secondaryButtons.setVisible(visible);
             }
         }
     }
 
     public EventBus getEventBus() {
         return eventBus;
     }
 
     public void removeFocus() {
         removeStyleName(FOCUS_CLASSNAME);
         removeStyleName(CHILD_FOCUS_CLASSNAME);
     }
 
     public void setFocus(boolean child) {
         String className = (child) ? CHILD_FOCUS_CLASSNAME : FOCUS_CLASSNAME;
         addStyleName(className);
     }
 
     public String getPath() {
         return path;
     }
 
     public void setPath(String path) {
         this.path = path;
     }
 
     public String getWorkspace() {
         return workspace;
     }
 
     public void setWorkspace(String workspace) {
         this.workspace = workspace;
     }
 
     public abstract String getDialog();
 
 }