Adding overflow menu to media player

third_party/WebKit/Source/core/html/shadow/MediaControlElements.cpp

 /*
  * Copyright (C) 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
  * Copyright (C) 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
@@ skipping 271 matching lines @@
     return button;
 }
 
 void MediaControlMuteButtonElement::defaultEventHandler(Event* event)
 {
     if (event->type() == EventTypeNames::click) {
         if (mediaElement().muted())
             Platform::current()->recordAction(UserMetricsAction("Media.Controls.Unmute"));
         else
             Platform::current()->recordAction(UserMetricsAction("Media.Controls.Mute"));
-
         mediaElement().setMuted(!mediaElement().muted());
         event->setDefaultHandled();
     }
 
     HTMLInputElement::defaultEventHandler(event);
 }
 
 void MediaControlMuteButtonElement::updateDisplayType()
 {
     setDisplayType(mediaElement().muted() ? MediaUnMuteButton : MediaMuteButton);
 }
 
+String MediaControlMuteButtonElement::getText()
+{
+    if (mediaElement().muted())
+        return mediaElement().locale().queryString(WebLocalizedString::OverflowMenuUnmute);

[liberato (no reviews please), 2016/08/24 16:44:22]

you might consider folding all of the queryString() into a non-virtual
MediaControElement::getText() fn.  the element subclasses can implement virtual
WebLocalizedString::Name getOverflowStringName(), called by getText.

saves some boiler plate code, and maybe makes it easier to see what's going on.

[kdsilva, 2016/08/26 18:11:02]

Done. Although I'm not sure what the default return value should be for the
getOverflowStringName() function since not all subclasses don't need to have an
overflow string name. Any ideas?

+    return mediaElement().locale().queryString(WebLocalizedString::OverflowMenuMute);
+}
+
 // ----------------------------
 
 MediaControlPlayButtonElement::MediaControlPlayButtonElement(MediaControls& mediaControls)
     : MediaControlInputElement(mediaControls, MediaPlayButton)
 {
 }
 
 MediaControlPlayButtonElement* MediaControlPlayButtonElement::create(MediaControls& mediaControls)
 {
     MediaControlPlayButtonElement* button = new MediaControlPlayButtonElement(mediaControls);
@@ skipping 85 matching lines @@
 
 void MediaControlToggleClosedCaptionsButtonElement::updateDisplayType()
 {
     bool captionsVisible = mediaElement().textTracksVisible();
     setDisplayType(captionsVisible ? MediaHideClosedCaptionsButton : MediaShowClosedCaptionsButton);
 }
 
 void MediaControlToggleClosedCaptionsButtonElement::defaultEventHandler(Event* event)
 {
     if (event->type() == EventTypeNames::click) {
+        if (mediaControls().overflowMenuVisible())
+            mediaControls().toggleOverflowMenu();
         mediaControls().toggleTextTrackList();
         updateDisplayType();
         event->setDefaultHandled();
     }
 
     HTMLInputElement::defaultEventHandler(event);
 }
 
+String MediaControlToggleClosedCaptionsButtonElement::getText()
+{
+    return mediaElement().locale().queryString(WebLocalizedString::OverflowMenuCaptions);
+}
+
 // ----------------------------
 
 MediaControlTextTrackListElement::MediaControlTextTrackListElement(MediaControls& mediaControls)
     : MediaControlDivElement(mediaControls, MediaTextTrackList)
 {
 }
 
 MediaControlTextTrackListElement* MediaControlTextTrackListElement::create(MediaControls& mediaControls)
 {
     MediaControlTextTrackListElement* element = new MediaControlTextTrackListElement(mediaControls);
@@ skipping 119 matching lines @@
     TextTrackList* trackList = mediaElement().textTracks();
     for (unsigned i = 0; i < trackList->length(); i++) {
         TextTrack* track = trackList->anonymousIndexedGetter(i);
         if (!track->canBeRendered())
             continue;
         appendChild(createTextTrackListItem(track));
     }
 }
 
 // ----------------------------
+MediaControlOverflowMenu::MediaControlOverflowMenu(MediaControls& mediaControls)
+    : MediaControlInputElement(mediaControls, MediaShowClosedCaptionsButton)
+{
+}
+
+MediaControlOverflowMenu* MediaControlOverflowMenu::create(MediaControls& mediaControls)
+{
+    MediaControlOverflowMenu* button = new MediaControlOverflowMenu(mediaControls);
+    button->ensureUserAgentShadowRoot();
+    button->setType(InputTypeNames::button);
+    button->setShadowPseudoId(AtomicString("-webkit-overflow-menu-button"));
+    button->setIsWanted(false);
+    return button;
+}
+
+void MediaControlOverflowMenu::defaultEventHandler(Event* event)
+{
+    if (event->type() == EventTypeNames::click) {
+        mediaControls().toggleOverflowMenu();
+        event->setDefaultHandled();
+    }
+
+    HTMLInputElement::defaultEventHandler(event);
+}
+
+// ----------------------------
+MediaControlOverflowMenuListElement::MediaControlOverflowMenuListElement(MediaControls& mediaControls)
+    : MediaControlDivElement(mediaControls, MediaShowClosedCaptionsButton)
+{
+}
+
+MediaControlOverflowMenuListElement* MediaControlOverflowMenuListElement::create(MediaControls& mediaControls)
+{
+    MediaControlOverflowMenuListElement* element = new MediaControlOverflowMenuListElement(mediaControls);
+    element->setIsWanted(false);
+    element->setShadowPseudoId(AtomicString("-internal-media-controls-overflow-menu-list"));
+    return element;
+}
+
+void MediaControlOverflowMenuListElement::setOverflowMenuControls(const std::set<MediaControlElementType>* controls)
+{
+    removeChildren(OmitSubtreeModifiedEvent);

[liberato (no reviews please), 2016/08/24 16:44:22]

if you choose to go the route of pre-allocating everything, then one could do
this ahead of time and "display: none" the elements that you don't want to show.
 that becomes simpler if one has a container div per overflow item that houses
both the label and the button.

if you don't go with pre-allocation, then nevermind :)

[kdsilva, 2016/08/26 18:11:02]

Done. Although I couldn't find a simple of changing the "display" attribute.
PTAL?

+    // A list of all buttons that can appear in the overflow menu.
+    std::vector<MediaControlInputElement*> potentialControls = mediaControls().getOverflowMenuButtons();
+
+    for (unsigned i = 0; i < potentialControls.size(); i++) {
+        MediaControlInputElement* element = potentialControls.at(i);
+        // Of all of the possible buttons that can be shown in the overflow menu,
+        // we include only the buttons that didn't fit within the media player.
+        if (controls->count(element->displayType())) {

[liberato (no reviews please), 2016/08/24 16:44:22]

if the original element handles providing its own overflow element, then this
becomes a little simpler.  MediaControls hands in the original elements that
didn't fit, then this function just asks each them for its overflow button. 
then, there's no need to do an inner traversal of the vector, nor assume
equality on displayType().

[kdsilva, 2016/08/26 18:11:03]

Done.

+            HTMLLabelElement* item = HTMLLabelElement::create(document());
+            item->setShadowPseudoId(AtomicString("-internal-media-controls-overflow-menu-list-item"));
+            item->appendChild(element);
+            item->appendChild(Text::create(document(), element->getText()));

[liberato (no reviews please), 2016/08/24 16:44:22]

does clicking on the label do anything?  is it supposed to?

[kdsilva, 2016/08/26 18:11:02]

Clicking on the label should perform the action the button is associated with.
Ideally, here, we wouldn't be appending two children but I'm not sure what a
better way would be to have a text show up here in lieu of the button icon. 

+            appendChild(item);
+        }
+    }
+}
+
+void MediaControlOverflowMenuListElement::showOverflowMenu(bool visible)
+{
+    setIsWanted(visible);
+}
+
+void MediaControlOverflowMenuListElement::defaultEventHandler(Event* event)
+{
+    if (event->type() == EventTypeNames::click)
+        event->setDefaultHandled();
+
+    MediaControlDivElement::defaultEventHandler(event);
+}
+
+// ----------------------------
 
 MediaControlTimelineElement::MediaControlTimelineElement(MediaControls& mediaControls)
     : MediaControlInputElement(mediaControls, MediaSlider)
 {
 }
 
 MediaControlTimelineElement* MediaControlTimelineElement::create(MediaControls& mediaControls)
 {
     MediaControlTimelineElement* timeline = new MediaControlTimelineElement(mediaControls);
     timeline->ensureUserAgentShadowRoot();
@@ skipping 164 matching lines @@
         event->setDefaultHandled();
     }
     HTMLInputElement::defaultEventHandler(event);
 }
 
 void MediaControlFullscreenButtonElement::setIsFullscreen(bool isFullscreen)
 {
     setDisplayType(isFullscreen ? MediaExitFullscreenButton : MediaEnterFullscreenButton);
 }
 
+String MediaControlFullscreenButtonElement::getText()
+{
+    return mediaElement().locale().queryString(WebLocalizedString::OverflowMenuFullscreen);
+}
+
 // ----------------------------
 
 MediaControlCastButtonElement::MediaControlCastButtonElement(MediaControls& mediaControls, bool isOverlayButton)
     : MediaControlInputElement(mediaControls, MediaCastOnButton), m_isOverlayButton(isOverlayButton)
 {
     if (m_isOverlayButton)
         recordMetrics(CastOverlayMetrics::Created);
     setIsPlayingRemotely(false);
 }
 
@@ skipping 43 matching lines @@
         }
     } else {
         if (m_isOverlayButton) {
             setDisplayType(MediaOverlayCastOffButton);
         } else {
             setDisplayType(MediaCastOffButton);
         }
     }
 }
 
+String MediaControlCastButtonElement::getText()
+{
+    if (mediaElement().isPlayingRemotely())
+        return mediaElement().locale().queryString(WebLocalizedString::OverflowMenuStopCast);
+    return mediaElement().locale().queryString(WebLocalizedString::OverflowMenuCast);
+}
+
 void MediaControlCastButtonElement::tryShowOverlay()
 {
     DCHECK(m_isOverlayButton);
 
     setIsWanted(true);
     if (elementFromCenter(*this) != &mediaElement()) {
         setIsWanted(false);
         return;
     }
 
@@ skipping 38 matching lines @@
 }
 
 MediaControlCurrentTimeDisplayElement* MediaControlCurrentTimeDisplayElement::create(MediaControls& mediaControls)
 {
     MediaControlCurrentTimeDisplayElement* element = new MediaControlCurrentTimeDisplayElement(mediaControls);
     element->setShadowPseudoId(AtomicString("-webkit-media-controls-current-time-display"));
     return element;
 }
 
 } // namespace blink