28e66ad668c2634756b874077625937473c4234c
[WebKit-https.git] / WebCore / accessibility / AccessibilityTableCell.cpp
1 /*
2  * Copyright (C) 2008 Apple Inc. 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 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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "AccessibilityTableCell.h"
31
32 #include "AXObjectCache.h"
33 #include "HTMLNames.h"
34 #include "RenderObject.h"
35 #include "RenderTableCell.h"
36
37 using namespace std;
38
39 namespace WebCore {
40     
41 using namespace HTMLNames;
42
43 AccessibilityTableCell::AccessibilityTableCell(RenderObject* renderer)
44     : AccessibilityRenderObject(renderer)
45 {
46 }
47
48 AccessibilityTableCell::~AccessibilityTableCell()
49 {
50 }
51
52 PassRefPtr<AccessibilityTableCell> AccessibilityTableCell::create(RenderObject* renderer)
53 {
54     return adoptRef(new AccessibilityTableCell(renderer));
55 }
56
57 bool AccessibilityTableCell::accessibilityIsIgnored() const
58 {
59     AccessibilityObjectInclusion decision = accessibilityIsIgnoredBase();
60     if (decision == IncludeObject)
61         return false;
62     if (decision == IgnoreObject)
63         return true;
64     
65     if (!isTableCell())
66         return AccessibilityRenderObject::accessibilityIsIgnored();
67     
68     return false;
69 }
70    
71 AccessibilityObject* AccessibilityTableCell::parentTable() const
72 {
73     if (!m_renderer || !m_renderer->isTableCell())
74         return 0;
75     
76     // Do not use getOrCreate. parentTable() can be called while the render tree is being modified 
77     // by javascript, and creating a table element may try to access the render tree while in a bad state.
78     // By using only get() implies that the AXTable must be created before AXTableCells. This should
79     // always be the case when AT clients access a table.
80     // https://bugs.webkit.org/show_bug.cgi?id=42652    
81     return axObjectCache()->get(toRenderTableCell(m_renderer)->table());
82 }
83     
84 bool AccessibilityTableCell::isTableCell() const
85 {
86     AccessibilityObject* table = parentTable();
87     if (!table || !table->isDataTable())
88         return false;
89     
90     return true;
91 }
92     
93 AccessibilityRole AccessibilityTableCell::roleValue() const
94 {
95     if (!isTableCell())
96         return AccessibilityRenderObject::roleValue();
97     
98     return CellRole;
99 }
100     
101 void AccessibilityTableCell::rowIndexRange(pair<int, int>& rowRange)
102 {
103     if (!m_renderer || !m_renderer->isTableCell())
104         return;
105     
106     RenderTableCell* renderCell = toRenderTableCell(m_renderer);
107     rowRange.first = renderCell->row();
108     rowRange.second = renderCell->rowSpan();
109     
110     // since our table might have multiple sections, we have to offset our row appropriately
111     RenderTableSection* section = renderCell->section();
112     RenderTable* table = renderCell->table();
113     if (!table || !section)
114         return;
115     
116     RenderTableSection* tableSection = table->header();
117     if (!tableSection)
118         tableSection = table->firstBody();
119     
120     unsigned rowOffset = 0;
121     while (tableSection) {
122         if (tableSection == section)
123             break;
124         rowOffset += tableSection->numRows();
125         tableSection = table->sectionBelow(tableSection, true); 
126     }
127
128     rowRange.first += rowOffset;
129 }
130     
131 void AccessibilityTableCell::columnIndexRange(pair<int, int>& columnRange)
132 {
133     if (!m_renderer || !m_renderer->isTableCell())
134         return;
135     
136     RenderTableCell* renderCell = toRenderTableCell(m_renderer);
137     columnRange.first = renderCell->col();
138     columnRange.second = renderCell->colSpan();    
139 }
140     
141 AccessibilityObject* AccessibilityTableCell::titleUIElement() const
142 {
143     // Try to find if the first cell in this row is a <th>. If it is,
144     // then it can act as the title ui element. (This is only in the
145     // case when the table is not appearing as an AXTable.)
146     if (isTableCell() || !m_renderer || !m_renderer->isTableCell())
147         return 0;
148
149     // Table cells that are th cannot have title ui elements, since by definition
150     // they are title ui elements
151     Node* node = m_renderer->node();
152     if (node && node->hasTagName(thTag))
153         return 0;
154     
155     RenderTableCell* renderCell = toRenderTableCell(m_renderer);
156
157     // If this cell is in the first column, there is no need to continue.
158     int col = renderCell->col();
159     if (!col)
160         return 0;
161
162     int row = renderCell->row();
163
164     RenderTableSection* section = renderCell->section();
165     if (!section)
166         return 0;
167     
168     RenderTableCell* headerCell = section->cellAt(row, 0).cell;
169     if (!headerCell || headerCell == renderCell)
170         return 0;
171
172     Node* cellElement = headerCell->node();
173     if (!cellElement || !cellElement->hasTagName(thTag))
174         return 0;
175     
176     return axObjectCache()->getOrCreate(headerCell);
177 }
178     
179 } // namespace WebCore