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 282 matching lines @@
         mediaElement().setMuted(!mediaElement().muted());
         event->setDefaultHandled();
     }
 
     HTMLInputElement::defaultEventHandler(event);
 }
 
 void MediaControlMuteButtonElement::updateDisplayType()
 {
     setDisplayType(mediaElement().muted() ? MediaUnMuteButton : MediaMuteButton);
+    updateOverflowString();

[liberato (no reviews please), 2016/09/01 18:05:19]

would it make sense to call this in setShouldShowButtonInOverflowMenu()?

not sure if it's functionally equivalent, but i also don't know that the
overflow menu is going to change much while it's shown.  i suppose that the
code, as written, would change 'play' to 'pause' if the video ended while the
overflow was shown.

whichever you think is best.

[kdsilva, 2016/09/05 14:39:35]

That works much better!

+}
+
+WebLocalizedString::Name MediaControlMuteButtonElement::getOverflowStringName()
+{
+    if (mediaElement().muted())
+        return WebLocalizedString::OverflowMenuUnmute;
+    return WebLocalizedString::OverflowMenuMute;
+}
+
+MediaControlInputElement* MediaControlMuteButtonElement::createOverflowButton(MediaControls& mediaControls)
+{
+    return MediaControlMuteButtonElement::create(mediaControls);
 }
 
 // ----------------------------
 
 MediaControlPlayButtonElement::MediaControlPlayButtonElement(MediaControls& mediaControls)
     : MediaControlInputElement(mediaControls, MediaPlayButton)
 {
 }
 
 MediaControlPlayButtonElement* MediaControlPlayButtonElement::create(MediaControls& mediaControls)
@@ skipping 87 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())

[mlamouri (slow - plz ping), 2016/09/01 18:29:15]

Can you add a comment explaining why you are doing this. At first, I thought of
a mistake then realised what you are doing and I have some background about your
work :). Others might be confused.

[kdsilva, 2016/09/05 14:39:35]

Done.

+            mediaControls().toggleOverflowMenu();
         mediaControls().toggleTextTrackList();
         updateDisplayType();
         event->setDefaultHandled();
     }
 
     HTMLInputElement::defaultEventHandler(event);
 }
 
+WebLocalizedString::Name MediaControlToggleClosedCaptionsButtonElement::getOverflowStringName()
+{
+    return WebLocalizedString::OverflowMenuCaptions;
+}
+
+MediaControlInputElement* MediaControlToggleClosedCaptionsButtonElement::createOverflowButton(MediaControls& mediaControls)
+{
+    return MediaControlToggleClosedCaptionsButtonElement::create(mediaControls);
+}
+
 // ----------------------------
 
 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));
     }
 }
 
 // ----------------------------
+MediaControlOverflowMenuButtonElement::MediaControlOverflowMenuButtonElement(MediaControls& mediaControls)
+    : MediaControlInputElement(mediaControls, MediaOverflowButton)
+{
+}
+
+MediaControlOverflowMenuButtonElement* MediaControlOverflowMenuButtonElement::create(MediaControls& mediaControls)
+{
+    MediaControlOverflowMenuButtonElement* button = new MediaControlOverflowMenuButtonElement(mediaControls);
+    button->ensureUserAgentShadowRoot();
+    button->setType(InputTypeNames::button);
+    button->setShadowPseudoId(AtomicString("-internal-overflow-menu-button"));
+    button->setIsWanted(false);
+    return button;
+}
+
+void MediaControlOverflowMenuButtonElement::defaultEventHandler(Event* event)
+{
+    if (event->type() == EventTypeNames::click) {
+        mediaControls().toggleOverflowMenu();
+        event->setDefaultHandled();
+    }
+
+    HTMLInputElement::defaultEventHandler(event);
+}
+
+// ----------------------------
+MediaControlOverflowMenuListElement::MediaControlOverflowMenuListElement(MediaControls& mediaControls)
+    : MediaControlDivElement(mediaControls, MediaOverflowList)
+{
+}
+
+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::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);
 }
 
+WebLocalizedString::Name MediaControlFullscreenButtonElement::getOverflowStringName()
+{
+    return WebLocalizedString::OverflowMenuFullscreen;
+}
+MediaControlInputElement* MediaControlFullscreenButtonElement::createOverflowButton(MediaControls& mediaControls)
+{
+    return MediaControlFullscreenButtonElement::create(mediaControls);
+}
+
 // ----------------------------
 
 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);
         }
     }
 }
 
+WebLocalizedString::Name MediaControlCastButtonElement::getOverflowStringName()
+{
+    if (mediaElement().isPlayingRemotely())
+        return WebLocalizedString::OverflowMenuStopCast;
+    return WebLocalizedString::OverflowMenuCast;
+}
+
 void MediaControlCastButtonElement::tryShowOverlay()
 {
     DCHECK(m_isOverlayButton);
 
     setIsWanted(true);
     if (elementFromCenter(*this) != &mediaElement()) {
         setIsWanted(false);
         return;
     }
 
     DCHECK(isWanted());
     if (!m_showUseCounted) {
         m_showUseCounted = true;
         recordMetrics(CastOverlayMetrics::Shown);
     }
 }
 
 bool MediaControlCastButtonElement::keepEventInNode(Event* event)
 {
     return isUserInteractionEvent(event);
 }
 
 void MediaControlCastButtonElement::recordMetrics(CastOverlayMetrics metric)
 {
     DCHECK(m_isOverlayButton);
     DEFINE_STATIC_LOCAL(EnumerationHistogram, overlayHistogram, ("Cast.Sender.Overlay", static_cast<int>(CastOverlayMetrics::Count)));
     overlayHistogram.count(static_cast<int>(metric));
 }
 
+MediaControlInputElement* MediaControlCastButtonElement::createOverflowButton(MediaControls& mediaControls)
+{
+    return MediaControlCastButtonElement::create(mediaControls, false);
+}
+
 // ----------------------------
 
 MediaControlTimeRemainingDisplayElement::MediaControlTimeRemainingDisplayElement(MediaControls& mediaControls)
     : MediaControlTimeDisplayElement(mediaControls, MediaTimeRemainingDisplay)
 {
 }
 
 MediaControlTimeRemainingDisplayElement* MediaControlTimeRemainingDisplayElement::create(MediaControls& mediaControls)
 {
     MediaControlTimeRemainingDisplayElement* element = new MediaControlTimeRemainingDisplayElement(mediaControls);
     element->setShadowPseudoId(AtomicString("-webkit-media-controls-time-remaining-display"));
     return element;
 }
 
 // ----------------------------
 
 MediaControlCurrentTimeDisplayElement::MediaControlCurrentTimeDisplayElement(MediaControls& mediaControls)
     : MediaControlTimeDisplayElement(mediaControls, MediaCurrentTimeDisplay)
 {
 }
 
 MediaControlCurrentTimeDisplayElement* MediaControlCurrentTimeDisplayElement::create(MediaControls& mediaControls)
 {
     MediaControlCurrentTimeDisplayElement* element = new MediaControlCurrentTimeDisplayElement(mediaControls);
     element->setShadowPseudoId(AtomicString("-webkit-media-controls-current-time-display"));
     return element;
 }
 
 } // namespace blink