Home | History | Annotate | Download | only in dom 
      1 /*
      2  * Copyright (C) 2011 Adobe Systems Incorporated. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions
      6  * are met:
      7  *
      8  * 1. Redistributions of source code must retain the above
      9  *    copyright notice, this list of conditions and the following
     10  *    disclaimer.
     11  * 2. Redistributions in binary form must reproduce the above
     12  *    copyright notice, this list of conditions and the following
     13  *    disclaimer in the documentation and/or other materials
     14  *    provided with the distribution.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER "AS IS" AND ANY
     17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE
     20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
     21  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
     25  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
     26  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     27  * SUCH DAMAGE.
     28  */
     29 
     30 #ifndef NamedFlow_h
     31 #define NamedFlow_h
     32 
     33 #include "bindings/v8/ScriptWrappable.h"
     34 #include "core/events/EventTarget.h"
     35 #include "wtf/RefCounted.h"
     36 #include "wtf/RefPtr.h"
     37 #include "wtf/text/AtomicString.h"
     38 
     39 namespace WebCore {
     40 
     41 class Document;
     42 class NamedFlowCollection;
     43 class Node;
     44 class NodeList;
     45 class RenderNamedFlowThread;
     46 class ExecutionContext;
     47 
     48 class NamedFlow : public RefCounted<NamedFlow>, public ScriptWrappable, public EventTargetWithInlineData {
     49     REFCOUNTED_EVENT_TARGET(NamedFlow);
     50 public:
     51     static PassRefPtr<NamedFlow> create(PassRefPtr<NamedFlowCollection> manager, const AtomicString& flowThreadName);
     52 
     53     ~NamedFlow();
     54 
     55     const AtomicString& name() const;
     56     bool overset() const;
     57     int firstEmptyRegionIndex() const;
     58     PassRefPtr<NodeList> getRegionsByContent(Node*);
     59     PassRefPtr<NodeList> getRegions();
     60     PassRefPtr<NodeList> getContent();
     61 
     62     virtual const AtomicString& interfaceName() const OVERRIDE;
     63     virtual ExecutionContext* executionContext() const OVERRIDE;
     64 
     65     // This function is called from the JS binding code to determine if the NamedFlow object is reachable or not.
     66     // If the object has listeners, the object should only be discarded if the parent Document is not reachable.
     67     Node* ownerNode() const;
     68 
     69     void setRenderer(RenderNamedFlowThread* parentFlowThread);
     70 
     71     enum FlowState {
     72         FlowStateCreated,
     73         FlowStateNull
     74     };
     75 
     76     FlowState flowState() const { return m_parentFlowThread ? FlowStateCreated : FlowStateNull; }
     77 
     78     void dispatchRegionLayoutUpdateEvent();
     79     void dispatchRegionOversetChangeEvent();
     80 
     81 private:
     82     NamedFlow(PassRefPtr<NamedFlowCollection>, const AtomicString&);
     83 
     84     // The name of the flow thread as specified in CSS.
     85     AtomicString m_flowThreadName;
     86 
     87     RefPtr<NamedFlowCollection> m_flowManager;
     88     RenderNamedFlowThread* m_parentFlowThread;
     89 };
     90 
     91 }
     92 
     93 #endif
     94