Home | History | Annotate | Download | only in shadow
      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 "core/platform/Timer.h"
     33 
     34 namespace WebCore {
     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 
     44     class SpinButtonOwner {
     45     public:
     46         virtual ~SpinButtonOwner() { }
     47         virtual void focusAndSelectSpinButtonOwner() = 0;
     48         virtual bool shouldSpinButtonRespondToMouseEvents() = 0;
     49         virtual bool shouldSpinButtonRespondToWheelEvents() = 0;
     50         virtual void spinButtonStepDown() = 0;
     51         virtual void spinButtonStepUp() = 0;
     52     };
     53 
     54     // The owner of SpinButtonElement must call removeSpinButtonOwner
     55     // because SpinButtonElement can be outlive SpinButtonOwner
     56     // implementation, e.g. during event handling.
     57     static PassRefPtr<SpinButtonElement> create(Document*, SpinButtonOwner&);
     58     UpDownState upDownState() const { return m_upDownState; }
     59     virtual void releaseCapture();
     60     void removeSpinButtonOwner() { m_spinButtonOwner = 0; }
     61 
     62     void step(int amount);
     63 
     64     virtual bool willRespondToMouseMoveEvents() OVERRIDE;
     65     virtual bool willRespondToMouseClickEvents() OVERRIDE;
     66 
     67     void forwardEvent(Event*);
     68 
     69 private:
     70     SpinButtonElement(Document*, SpinButtonOwner&);
     71 
     72     virtual void detach(const AttachContext& = AttachContext()) OVERRIDE;
     73     virtual bool isSpinButtonElement() const { return true; }
     74     virtual bool isDisabledFormControl() const OVERRIDE { return shadowHost() && shadowHost()->isDisabledFormControl(); }
     75     virtual bool matchesReadOnlyPseudoClass() const OVERRIDE;
     76     virtual bool matchesReadWritePseudoClass() const OVERRIDE;
     77     virtual void defaultEventHandler(Event*);
     78     virtual void willOpenPopup() OVERRIDE;
     79     void doStepAction(int);
     80     void startRepeatingTimer();
     81     void stopRepeatingTimer();
     82     void repeatingTimerFired(Timer<SpinButtonElement>*);
     83     virtual void setHovered(bool = true);
     84     bool shouldRespondToMouseEvents();
     85     virtual bool isMouseFocusable() const { return false; }
     86 
     87     SpinButtonOwner* m_spinButtonOwner;
     88     bool m_capturing;
     89     UpDownState m_upDownState;
     90     UpDownState m_pressStartingState;
     91     Timer<SpinButtonElement> m_repeatingTimer;
     92 };
     93 
     94 inline SpinButtonElement* toSpinButtonElement(Element* element)
     95 {
     96     ASSERT_WITH_SECURITY_IMPLICATION(!element || element->isSpinButtonElement());
     97     return static_cast<SpinButtonElement*>(element);
     98 }
     99 
    100 } // namespace
    101 
    102 #endif
    103