src/third_party/WebKit/Source/core/html/shadow/SpinButtonElement.h

   1 /*
   2  * Copyright (C) 2006, 2008, 2010 Apple Inc. All rights reserved.
   3  * Copyright (C) 2010 Google Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef SpinButtonElement_h
  28 #define SpinButtonElement_h
  29
  30 #include "core/html/HTMLDivElement.h"
  31 #include "core/page/PopupOpeningObserver.h"
  32 #include "platform/Timer.h"
  33
  34 namespace blink {
  35
  36 class SpinButtonElement final : public HTMLDivElement, public PopupOpeningObserver {
  37 public:
  38     enum UpDownState {
  39         Indeterminate, // Hovered, but the event is not handled.
  40         Down,
  41         Up,
  42     };
  43     enum EventDispatch {
  44         EventDispatchAllowed,
  45         EventDispatchDisallowed,
  46     };
  47     class SpinButtonOwner : public WillBeGarbageCollectedMixin {
  48     public:
  49         virtual ~SpinButtonOwner() { }
  50         virtual void focusAndSelectSpinButtonOwner() = 0;
  51         virtual bool shouldSpinButtonRespondToMouseEvents() = 0;
  52         virtual bool shouldSpinButtonRespondToWheelEvents() = 0;
  53         virtual void spinButtonDidReleaseMouseCapture(EventDispatch) = 0;
  54         virtual void spinButtonStepDown() = 0;
  55         virtual void spinButtonStepUp() = 0;
  56     };
  57
  58     // The owner of SpinButtonElement must call removeSpinButtonOwner
  59     // because SpinButtonElement can be outlive SpinButtonOwner
  60     // implementation, e.g. during event handling.
  61     static PassRefPtrWillBeRawPtr<SpinButtonElement> create(Document&, SpinButtonOwner&);
  62     UpDownState upDownState() const { return m_upDownState; }
  63     void releaseCapture(EventDispatch = EventDispatchAllowed);
  64     void removeSpinButtonOwner() { m_spinButtonOwner = nullptr; }
  65
  66     void step(int amount);
  67
  68     virtual bool willRespondToMouseMoveEvents() override;
  69     virtual bool willRespondToMouseClickEvents() override;
  70
  71     void forwardEvent(Event*);
  72
  73     virtual void trace(Visitor*) override;
  74
  75 private:
  76     SpinButtonElement(Document&, SpinButtonOwner&);
  77
  78     virtual void detach(const AttachContext&) override;
  79     virtual bool isSpinButtonElement() const override { return true; }
  80     virtual bool isDisabledFormControl() const override { return shadowHost() && shadowHost()->isDisabledFormControl(); }
  81     virtual bool matchesReadOnlyPseudoClass() const override;
  82     virtual bool matchesReadWritePseudoClass() const override;
  83     virtual void defaultEventHandler(Event*) override;
  84     virtual void willOpenPopup() override;
  85     void doStepAction(int);
  86     void startRepeatingTimer();
  87     void stopRepeatingTimer();
  88     void repeatingTimerFired(Timer<SpinButtonElement>*);
  89     virtual void setHovered(bool = true) override;
  90     bool shouldRespondToMouseEvents();
  91     virtual bool isMouseFocusable() const override { return false; }
  92
  93     RawPtrWillBeMember<SpinButtonOwner> m_spinButtonOwner;
  94     bool m_capturing;
  95     UpDownState m_upDownState;
  96     UpDownState m_pressStartingState;
  97     Timer<SpinButtonElement> m_repeatingTimer;
  98 };
  99
 100 DEFINE_TYPE_CASTS(SpinButtonElement, Node, node, toElement(node)->isSpinButtonElement(), toElement(node).isSpinButtonElement());
 101
 102 } // namespace
 103
 104 #endif