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 284 matching lines @@
     }
 
     HTMLInputElement::defaultEventHandler(event);
 }
 
 void MediaControlMuteButtonElement::updateDisplayType()
 {
     setDisplayType(mediaElement().muted() ? MediaUnMuteButton : MediaMuteButton);
 }
 
+WebLocalizedString::Name MediaControlMuteButtonElement::getOverflowStringName()
+{
+    if (mediaElement().muted())
+        return WebLocalizedString::OverflowMenuUnmute;
+    return WebLocalizedString::OverflowMenuMute;
+}
+
 // ----------------------------
 
 MediaControlPlayButtonElement::MediaControlPlayButtonElement(MediaControls& mediaControls)
     : MediaControlInputElement(mediaControls, MediaPlayButton)
 {
 }
 
 MediaControlPlayButtonElement* MediaControlPlayButtonElement::create(MediaControls& mediaControls)
 {
     MediaControlPlayButtonElement* button = new MediaControlPlayButtonElement(mediaControls);
@@ skipping 22 matching lines @@
         event->setDefaultHandled();
     }
     HTMLInputElement::defaultEventHandler(event);
 }
 
 void MediaControlPlayButtonElement::updateDisplayType()
 {
     setDisplayType(mediaElement().paused() ? MediaPlayButton : MediaPauseButton);
 }
 
+WebLocalizedString::Name MediaControlPlayButtonElement::getOverflowStringName()
+{
+    if (mediaElement().paused())
+        return WebLocalizedString::OverflowMenuPlay;
+    return WebLocalizedString::OverflowMenuPause;
+}
+
 // ----------------------------
 
 MediaControlOverlayPlayButtonElement::MediaControlOverlayPlayButtonElement(MediaControls& mediaControls)
     : MediaControlInputElement(mediaControls, MediaOverlayPlayButton)
 {
 }
 
 MediaControlOverlayPlayButtonElement* MediaControlOverlayPlayButtonElement::create(MediaControls& mediaControls)
 {
     MediaControlOverlayPlayButtonElement* button = new MediaControlOverlayPlayButtonElement(mediaControls);
@@ skipping 43 matching lines @@
 
 void MediaControlToggleClosedCaptionsButtonElement::updateDisplayType()
 {
     bool captionsVisible = mediaElement().textTracksVisible();
     setDisplayType(captionsVisible ? MediaHideClosedCaptionsButton : MediaShowClosedCaptionsButton);
 }
 
 void MediaControlToggleClosedCaptionsButtonElement::defaultEventHandler(Event* event)
 {
     if (event->type() == EventTypeNames::click) {
+        // If the user opens up the closed captions menu from the overfow menu,
+        // the overflow menu should no longer be visible.
+        if (mediaControls().overflowMenuVisible())
+            mediaControls().toggleOverflowMenu();
         mediaControls().toggleTextTrackList();
         updateDisplayType();
         event->setDefaultHandled();
     }
 
     HTMLInputElement::defaultEventHandler(event);
 }
 
+WebLocalizedString::Name MediaControlToggleClosedCaptionsButtonElement::getOverflowStringName()
+{
+    return 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));
     }
 }
 
 // ----------------------------
+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);

[mlamouri (slow - plz ping), 2016/09/06 10:25:45]

nit: I'm not entirely convinced we need to wrap setIsWanted() into
showOverflowMenu(). If this is a leftover from another design, maybe you could
consider removing. If you think it makes it easier to read, feel free to leave.

[kdsilva, 2016/09/06 17:32:46]

Done.

+}
+
+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;

[mlamouri (slow - plz ping), 2016/09/06 10:25:45]

Should there be an enter and exit fullscreen version?

[kdsilva, 2016/09/06 17:32:46]

Done.

+}
+
 // ----------------------------
 
 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;
     }
 
@@ 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