accessible/xul/XULSelectControlAccessible.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "XULSelectControlAccessible.h"
   8
   9 #include "nsAccessibilityService.h"
  10 #include "DocAccessible.h"
  11
  12 #include "nsIDOMXULSelectCntrlItemEl.h"
  13 #include "nsIDOMXULMultSelectCntrlEl.h"
  14
  15 #include "mozilla/dom/Element.h"
  16 #include "mozilla/dom/KeyboardEventBinding.h"
  17
  18 using namespace mozilla;
  19 using namespace mozilla::a11y;
  20
  21 ////////////////////////////////////////////////////////////////////////////////
  22 // XULSelectControlAccessible
  23 ////////////////////////////////////////////////////////////////////////////////
  24
  25 XULSelectControlAccessible::XULSelectControlAccessible(nsIContent* aContent,
  26                                                        DocAccessible* aDoc)
  27     : AccessibleWrap(aContent, aDoc) {
  28   mGenericTypes |= eSelect;
  29   mSelectControl = aContent->AsElement();
  30 }
  31
  32 ////////////////////////////////////////////////////////////////////////////////
  33 // XULSelectControlAccessible: LocalAccessible
  34
  35 void XULSelectControlAccessible::Shutdown() {
  36   mSelectControl = nullptr;
  37   AccessibleWrap::Shutdown();
  38 }
  39
  40 ////////////////////////////////////////////////////////////////////////////////
  41 // XULSelectControlAccessible: SelectAccessible
  42
  43 void XULSelectControlAccessible::SelectedItems(
  44     nsTArray<LocalAccessible*>* aItems) {
  45   // For XUL multi-select control
  46   nsCOMPtr<nsIDOMXULMultiSelectControlElement> xulMultiSelect =
  47       mSelectControl->AsXULMultiSelectControl();
  48   if (xulMultiSelect) {
  49     int32_t length = 0;
  50     xulMultiSelect->GetSelectedCount(&length);
  51     for (int32_t index = 0; index < length; index++) {
  52       RefPtr<dom::Element> element;
  53       xulMultiSelect->MultiGetSelectedItem(index, getter_AddRefs(element));
  54       LocalAccessible* item = mDoc->GetAccessible(element);
  55       if (item) aItems->AppendElement(item);
  56     }
  57   } else {  // Single select?
  58     nsCOMPtr<nsIDOMXULSelectControlElement> selectControl =
  59         mSelectControl->AsXULSelectControl();
  60     RefPtr<dom::Element> element;
  61     selectControl->GetSelectedItem(getter_AddRefs(element));
  62     if (element) {
  63       LocalAccessible* item = mDoc->GetAccessible(element);
  64       if (item) aItems->AppendElement(item);
  65     }
  66   }
  67 }
  68
  69 LocalAccessible* XULSelectControlAccessible::GetSelectedItem(uint32_t aIndex) {
  70   nsCOMPtr<nsIDOMXULMultiSelectControlElement> multiSelectControl =
  71       mSelectControl->AsXULMultiSelectControl();
  72
  73   RefPtr<dom::Element> element;
  74   if (multiSelectControl) {
  75     multiSelectControl->MultiGetSelectedItem(aIndex, getter_AddRefs(element));
  76   } else if (aIndex == 0) {
  77     nsCOMPtr<nsIDOMXULSelectControlElement> selectControl =
  78         mSelectControl->AsXULSelectControl();
  79     if (selectControl) {
  80       selectControl->GetSelectedItem(getter_AddRefs(element));
  81     }
  82   }
  83
  84   return element && mDoc ? mDoc->GetAccessible(element) : nullptr;
  85 }
  86
  87 uint32_t XULSelectControlAccessible::SelectedItemCount() {
  88   // For XUL multi-select control
  89   nsCOMPtr<nsIDOMXULMultiSelectControlElement> multiSelectControl =
  90       mSelectControl->AsXULMultiSelectControl();
  91   if (multiSelectControl) {
  92     int32_t count = 0;
  93     multiSelectControl->GetSelectedCount(&count);
  94     return count;
  95   }
  96
  97   // For XUL single-select control/menulist
  98   nsCOMPtr<nsIDOMXULSelectControlElement> selectControl =
  99       mSelectControl->AsXULSelectControl();
 100   if (selectControl) {
 101     int32_t index = -1;
 102     selectControl->GetSelectedIndex(&index);
 103     return (index >= 0) ? 1 : 0;
 104   }
 105
 106   return 0;
 107 }
 108
 109 bool XULSelectControlAccessible::AddItemToSelection(uint32_t aIndex) {
 110   LocalAccessible* item = LocalChildAt(aIndex);
 111   if (!item || !item->GetContent()) return false;
 112
 113   nsCOMPtr<nsIDOMXULSelectControlItemElement> itemElm =
 114       item->GetContent()->AsElement()->AsXULSelectControlItem();
 115   if (!itemElm) return false;
 116
 117   bool isItemSelected = false;
 118   itemElm->GetSelected(&isItemSelected);
 119   if (isItemSelected) return true;
 120
 121   nsCOMPtr<nsIDOMXULMultiSelectControlElement> multiSelectControl =
 122       mSelectControl->AsXULMultiSelectControl();
 123
 124   if (multiSelectControl) {
 125     multiSelectControl->AddItemToSelection(itemElm);
 126   } else {
 127     nsCOMPtr<nsIDOMXULSelectControlElement> selectControl =
 128         mSelectControl->AsXULSelectControl();
 129     if (selectControl) {
 130       selectControl->SetSelectedItem(item->Elm());
 131     }
 132   }
 133
 134   return true;
 135 }
 136
 137 bool XULSelectControlAccessible::RemoveItemFromSelection(uint32_t aIndex) {
 138   LocalAccessible* item = LocalChildAt(aIndex);
 139   if (!item || !item->GetContent()) return false;
 140
 141   nsCOMPtr<nsIDOMXULSelectControlItemElement> itemElm =
 142       item->GetContent()->AsElement()->AsXULSelectControlItem();
 143   if (!itemElm) return false;
 144
 145   bool isItemSelected = false;
 146   itemElm->GetSelected(&isItemSelected);
 147   if (!isItemSelected) return true;
 148
 149   nsCOMPtr<nsIDOMXULMultiSelectControlElement> multiSelectControl =
 150       mSelectControl->AsXULMultiSelectControl();
 151
 152   if (multiSelectControl) {
 153     multiSelectControl->RemoveItemFromSelection(itemElm);
 154   } else {
 155     nsCOMPtr<nsIDOMXULSelectControlElement> selectControl =
 156         mSelectControl->AsXULSelectControl();
 157     if (selectControl) {
 158       selectControl->SetSelectedItem(nullptr);
 159     }
 160   }
 161
 162   return true;
 163 }
 164
 165 bool XULSelectControlAccessible::IsItemSelected(uint32_t aIndex) {
 166   LocalAccessible* item = LocalChildAt(aIndex);
 167   if (!item || !item->GetContent()) return false;
 168
 169   nsCOMPtr<nsIDOMXULSelectControlItemElement> itemElm =
 170       item->GetContent()->AsElement()->AsXULSelectControlItem();
 171   if (!itemElm) return false;
 172
 173   bool isItemSelected = false;
 174   itemElm->GetSelected(&isItemSelected);
 175   return isItemSelected;
 176 }
 177
 178 bool XULSelectControlAccessible::UnselectAll() {
 179   nsCOMPtr<nsIDOMXULMultiSelectControlElement> multiSelectControl =
 180       mSelectControl->AsXULMultiSelectControl();
 181   if (multiSelectControl) {
 182     multiSelectControl->ClearSelection();
 183   } else {
 184     nsCOMPtr<nsIDOMXULSelectControlElement> selectControl =
 185         mSelectControl->AsXULSelectControl();
 186     if (selectControl) {
 187       selectControl->SetSelectedIndex(-1);
 188     }
 189   }
 190
 191   return true;
 192 }
 193
 194 bool XULSelectControlAccessible::SelectAll() {
 195   nsCOMPtr<nsIDOMXULMultiSelectControlElement> multiSelectControl =
 196       mSelectControl->AsXULMultiSelectControl();
 197   if (multiSelectControl) {
 198     multiSelectControl->SelectAll();
 199     return true;
 200   }
 201
 202   // otherwise, don't support this method
 203   return false;
 204 }
 205
 206 ////////////////////////////////////////////////////////////////////////////////
 207 // XULSelectControlAccessible: Widgets
 208
 209 LocalAccessible* XULSelectControlAccessible::CurrentItem() const {
 210   // aria-activedescendant should override.
 211   LocalAccessible* current = AccessibleWrap::CurrentItem();
 212   if (current) {
 213     return current;
 214   }
 215
 216   if (!mSelectControl) return nullptr;
 217
 218   RefPtr<dom::Element> currentItemElm;
 219   nsCOMPtr<nsIDOMXULMultiSelectControlElement> multiSelectControl =
 220       mSelectControl->AsXULMultiSelectControl();
 221   if (multiSelectControl) {
 222     multiSelectControl->GetCurrentItem(getter_AddRefs(currentItemElm));
 223   } else {
 224     nsCOMPtr<nsIDOMXULSelectControlElement> selectControl =
 225         mSelectControl->AsXULSelectControl();
 226     if (selectControl) {
 227       selectControl->GetSelectedItem(getter_AddRefs(currentItemElm));
 228     }
 229   }
 230
 231   if (currentItemElm) {
 232     DocAccessible* document = Document();
 233     if (document) return document->GetAccessible(currentItemElm);
 234   }
 235
 236   return nullptr;
 237 }
 238
 239 void XULSelectControlAccessible::SetCurrentItem(const LocalAccessible* aItem) {
 240   if (!mSelectControl) return;
 241
 242   nsCOMPtr<dom::Element> itemElm = aItem->Elm();
 243   nsCOMPtr<nsIDOMXULMultiSelectControlElement> multiSelectControl =
 244       itemElm->AsXULMultiSelectControl();
 245   if (multiSelectControl) {
 246     multiSelectControl->SetCurrentItem(itemElm);
 247   } else {
 248     nsCOMPtr<nsIDOMXULSelectControlElement> selectControl =
 249         mSelectControl->AsXULSelectControl();
 250     if (selectControl) {
 251       selectControl->SetSelectedItem(itemElm);
 252     }
 253   }
 254 }