src/third_party/WebKit/Source/core/page/CustomContextMenuProvider.cpp

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "config.h"
   6 #include "core/page/CustomContextMenuProvider.h"
   7
   8 #include "core/dom/Document.h"
   9 #include "core/dom/ElementTraversal.h"
  10 #include "core/events/EventDispatcher.h"
  11 #include "core/events/MouseEvent.h"
  12 #include "core/html/HTMLMenuElement.h"
  13 #include "core/html/HTMLMenuItemElement.h"
  14 #include "core/page/ContextMenuController.h"
  15 #include "core/page/Page.h"
  16 #include "platform/ContextMenu.h"
  17
  18 namespace blink {
  19
  20 using namespace HTMLNames;
  21
  22 CustomContextMenuProvider::CustomContextMenuProvider(HTMLMenuElement& menu, HTMLElement& subject)
  23     : m_menu(menu)
  24     , m_subjectElement(subject)
  25 {
  26 }
  27
  28 CustomContextMenuProvider::~CustomContextMenuProvider()
  29 {
  30 }
  31
  32 void CustomContextMenuProvider::trace(Visitor* visitor)
  33 {
  34     visitor->trace(m_menu);
  35     visitor->trace(m_subjectElement);
  36     visitor->trace(m_menuItems);
  37     ContextMenuProvider::trace(visitor);
  38 }
  39
  40 void CustomContextMenuProvider::populateContextMenu(ContextMenu* menu)
  41 {
  42     populateContextMenuItems(*m_menu, *menu);
  43 }
  44
  45 void CustomContextMenuProvider::contextMenuItemSelected(const ContextMenuItem* item)
  46 {
  47     if (HTMLElement* element = menuItemAt(item->action())) {
  48         RefPtrWillBeRawPtr<SimulatedMouseEvent> click = SimulatedMouseEvent::create(EventTypeNames::click, m_menu->document().domWindow(), Event::create());
  49         click->setRelatedTarget(m_subjectElement.get());
  50         element->dispatchEvent(click.release());
  51     }
  52 }
  53
  54 void CustomContextMenuProvider::contextMenuCleared()
  55 {
  56     m_menuItems.clear();
  57     m_subjectElement = nullptr;
  58 }
  59
  60 void CustomContextMenuProvider::appendSeparator(ContextMenu& contextMenu)
  61 {
  62     // Avoid separators at the start of any menu and submenu.
  63     if (!contextMenu.items().size())
  64         return;
  65
  66     // Collapse all sequences of two or more adjacent separators in the menu or
  67     // any submenus to a single separator.
  68     ContextMenuItem lastItem = contextMenu.items().last();
  69     if (lastItem.type() == SeparatorType)
  70         return;
  71
  72     contextMenu.appendItem(ContextMenuItem(SeparatorType, ContextMenuItemCustomTagNoAction, String()));
  73 }
  74
  75 void CustomContextMenuProvider::appendMenuItem(HTMLMenuItemElement* menuItem, ContextMenu& contextMenu)
  76 {
  77     // Avoid menuitems with no label.
  78     String labelString = menuItem->fastGetAttribute(labelAttr);
  79     if (labelString.isEmpty())
  80         return;
  81
  82     m_menuItems.append(menuItem);
  83     contextMenu.appendItem(ContextMenuItem(ActionType, static_cast<ContextMenuAction>(ContextMenuItemBaseCustomTag + m_menuItems.size() - 1), labelString));
  84 }
  85
  86 void CustomContextMenuProvider::populateContextMenuItems(const HTMLMenuElement& menu, ContextMenu& contextMenu)
  87 {
  88     HTMLElement* nextElement = Traversal<HTMLElement>::firstWithin(menu);
  89     while (nextElement) {
  90         if (isHTMLHRElement(*nextElement)) {
  91             appendSeparator(contextMenu);
  92             nextElement = Traversal<HTMLElement>::next(*nextElement, &menu);
  93         } else if (isHTMLMenuElement(*nextElement)) {
  94             ContextMenu subMenu;
  95             String labelString = nextElement->fastGetAttribute(labelAttr);
  96             if (labelString.isNull()) {
  97                 appendSeparator(contextMenu);
  98                 populateContextMenuItems(*toHTMLMenuElement(nextElement), contextMenu);
  99                 appendSeparator(contextMenu);
 100             } else if (!labelString.isEmpty()) {
 101                 populateContextMenuItems(*toHTMLMenuElement(nextElement), subMenu);
 102                 contextMenu.appendItem(ContextMenuItem(SubmenuType, ContextMenuItemCustomTagNoAction, labelString, &subMenu));
 103             }
 104             nextElement = Traversal<HTMLElement>::nextSibling(*nextElement);
 105         } else if (isHTMLMenuItemElement(*nextElement)) {
 106             appendMenuItem(toHTMLMenuItemElement(nextElement), contextMenu);
 107             if (ContextMenuItemBaseCustomTag + m_menuItems.size() >= ContextMenuItemLastCustomTag)
 108                 break;
 109             nextElement = Traversal<HTMLElement>::next(*nextElement, &menu);
 110         } else {
 111             nextElement = Traversal<HTMLElement>::next(*nextElement, &menu);
 112         }
 113     }
 114
 115     // Remove separators at the end of the menu and any submenus.
 116     while (contextMenu.items().size() && contextMenu.items().last().type() == SeparatorType)
 117         contextMenu.removeLastItem();
 118 }
 119
 120 HTMLElement* CustomContextMenuProvider::menuItemAt(unsigned menuId)
 121 {
 122     int itemIndex = menuId - ContextMenuItemBaseCustomTag;
 123     if (itemIndex < 0 || static_cast<unsigned long>(itemIndex) >= m_menuItems.size())
 124         return nullptr;
 125     return m_menuItems[itemIndex].get();
 126 }
 127
 128 } // namespace blink