/* ============================================================================== This file is part of the JUCE library. Copyright (c) 2013 - Raw Material Software Ltd. Permission is granted to use this software under the terms of either: a) the GPL v2 (or any later version) b) the Affero GPL v3 Details of these licenses can be found at: www.gnu.org/licenses JUCE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. ------------------------------------------------------------------------------ To release a closed-source product which uses JUCE, commercial licenses are available: visit www.juce.com for more information. ============================================================================== */ class ListBox::RowComponent : public Component, public TooltipClient { public: RowComponent (ListBox& lb) : owner (lb), row (-1), selected (false), isDragging (false), selectRowOnMouseUp (false) { } void paint (Graphics& g) override { if (ListBoxModel* m = owner.getModel()) m->paintListBoxItem (row, g, getWidth(), getHeight(), selected); } void update (const int newRow, const bool nowSelected) { if (row != newRow || selected != nowSelected) { repaint(); row = newRow; selected = nowSelected; } if (ListBoxModel* m = owner.getModel()) { customComponent = m->refreshComponentForRow (newRow, nowSelected, customComponent.release()); if (customComponent != nullptr) { addAndMakeVisible (customComponent); customComponent->setBounds (getLocalBounds()); } } } void mouseDown (const MouseEvent& e) override { isDragging = false; selectRowOnMouseUp = false; if (isEnabled()) { if (! selected) { owner.selectRowsBasedOnModifierKeys (row, e.mods, false); if (ListBoxModel* m = owner.getModel()) m->listBoxItemClicked (row, e); } else { selectRowOnMouseUp = true; } } } void mouseUp (const MouseEvent& e) override { if (isEnabled() && selectRowOnMouseUp && ! isDragging) { owner.selectRowsBasedOnModifierKeys (row, e.mods, true); if (ListBoxModel* m = owner.getModel()) m->listBoxItemClicked (row, e); } } void mouseDoubleClick (const MouseEvent& e) override { if (ListBoxModel* m = owner.getModel()) if (isEnabled()) m->listBoxItemDoubleClicked (row, e); } void mouseDrag (const MouseEvent& e) override { if (ListBoxModel* m = owner.getModel()) { if (isEnabled() && ! (e.mouseWasClicked() || isDragging)) { const SparseSet selectedRows (owner.getSelectedRows()); if (selectedRows.size() > 0) { const var dragDescription (m->getDragSourceDescription (selectedRows)); if (! (dragDescription.isVoid() || (dragDescription.isString() && dragDescription.toString().isEmpty()))) { isDragging = true; owner.startDragAndDrop (e, dragDescription, true); } } } } } void resized() override { if (customComponent != nullptr) customComponent->setBounds (getLocalBounds()); } String getTooltip() override { if (ListBoxModel* m = owner.getModel()) return m->getTooltipForRow (row); return String::empty; } ScopedPointer customComponent; private: ListBox& owner; int row; bool selected, isDragging, selectRowOnMouseUp; JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (RowComponent) }; //============================================================================== class ListBox::ListViewport : public Viewport { public: ListViewport (ListBox& lb) : owner (lb) { setWantsKeyboardFocus (false); Component* const content = new Component(); setViewedComponent (content); content->setWantsKeyboardFocus (false); } RowComponent* getComponentForRow (const int row) const noexcept { return rows [row % jmax (1, rows.size())]; } RowComponent* getComponentForRowIfOnscreen (const int row) const noexcept { return (row >= firstIndex && row < firstIndex + rows.size()) ? getComponentForRow (row) : nullptr; } int getRowNumberOfComponent (Component* const rowComponent) const noexcept { const int index = getIndexOfChildComponent (rowComponent); const int num = rows.size(); for (int i = num; --i >= 0;) if (((firstIndex + i) % jmax (1, num)) == index) return firstIndex + i; return -1; } void visibleAreaChanged (const Rectangle&) override { updateVisibleArea (true); if (ListBoxModel* m = owner.getModel()) m->listWasScrolled(); } void updateVisibleArea (const bool makeSureItUpdatesContent) { hasUpdated = false; const int newX = getViewedComponent()->getX(); int newY = getViewedComponent()->getY(); const int newW = jmax (owner.minimumRowWidth, getMaximumVisibleWidth()); const int newH = owner.totalItems * owner.getRowHeight(); if (newY + newH < getMaximumVisibleHeight() && newH > getMaximumVisibleHeight()) newY = getMaximumVisibleHeight() - newH; getViewedComponent()->setBounds (newX, newY, newW, newH); if (makeSureItUpdatesContent && ! hasUpdated) updateContents(); } void updateContents() { hasUpdated = true; const int rowH = owner.getRowHeight(); if (rowH > 0) { const int y = getViewPositionY(); const int w = getViewedComponent()->getWidth(); const int numNeeded = 2 + getMaximumVisibleHeight() / rowH; rows.removeRange (numNeeded, rows.size()); while (numNeeded > rows.size()) { RowComponent* newRow = new RowComponent (owner); rows.add (newRow); getViewedComponent()->addAndMakeVisible (newRow); } firstIndex = y / rowH; firstWholeIndex = (y + rowH - 1) / rowH; lastWholeIndex = (y + getMaximumVisibleHeight() - 1) / rowH; for (int i = 0; i < numNeeded; ++i) { const int row = i + firstIndex; if (RowComponent* const rowComp = getComponentForRow (row)) { rowComp->setBounds (0, row * rowH, w, rowH); rowComp->update (row, owner.isRowSelected (row)); } } } if (owner.headerComponent != nullptr) owner.headerComponent->setBounds (owner.outlineThickness + getViewedComponent()->getX(), owner.outlineThickness, jmax (owner.getWidth() - owner.outlineThickness * 2, getViewedComponent()->getWidth()), owner.headerComponent->getHeight()); } void selectRow (const int row, const int rowH, const bool dontScroll, const int lastSelectedRow, const int totalRows, const bool isMouseClick) { hasUpdated = false; if (row < firstWholeIndex && ! dontScroll) { setViewPosition (getViewPositionX(), row * rowH); } else if (row >= lastWholeIndex && ! dontScroll) { const int rowsOnScreen = lastWholeIndex - firstWholeIndex; if (row >= lastSelectedRow + rowsOnScreen && rowsOnScreen < totalRows - 1 && ! isMouseClick) { setViewPosition (getViewPositionX(), jlimit (0, jmax (0, totalRows - rowsOnScreen), row) * rowH); } else { setViewPosition (getViewPositionX(), jmax (0, (row + 1) * rowH - getMaximumVisibleHeight())); } } if (! hasUpdated) updateContents(); } void scrollToEnsureRowIsOnscreen (const int row, const int rowH) { if (row < firstWholeIndex) { setViewPosition (getViewPositionX(), row * rowH); } else if (row >= lastWholeIndex) { setViewPosition (getViewPositionX(), jmax (0, (row + 1) * rowH - getMaximumVisibleHeight())); } } void paint (Graphics& g) override { if (isOpaque()) g.fillAll (owner.findColour (ListBox::backgroundColourId)); } bool keyPressed (const KeyPress& key) override { if (Viewport::respondsToKey (key)) { const int allowableMods = owner.multipleSelection ? ModifierKeys::shiftModifier : 0; if ((key.getModifiers().getRawFlags() & ~allowableMods) == 0) { // we want to avoid these keypresses going to the viewport, and instead allow // them to pass up to our listbox.. return false; } } return Viewport::keyPressed (key); } private: ListBox& owner; OwnedArray rows; int firstIndex, firstWholeIndex, lastWholeIndex; bool hasUpdated; JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ListViewport) }; //============================================================================== class ListBoxMouseMoveSelector : public MouseListener { public: ListBoxMouseMoveSelector (ListBox& lb) : owner (lb) { owner.addMouseListener (this, true); } void mouseMove (const MouseEvent& e) override { const MouseEvent e2 (e.getEventRelativeTo (&owner)); owner.selectRow (owner.getRowContainingPosition (e2.x, e2.y), true); } void mouseExit (const MouseEvent& e) override { mouseMove (e); } private: ListBox& owner; JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ListBoxMouseMoveSelector) }; //============================================================================== ListBox::ListBox (const String& name, ListBoxModel* const m) : Component (name), model (m), totalItems (0), rowHeight (22), minimumRowWidth (0), outlineThickness (0), lastRowSelected (-1), multipleSelection (false), hasDoneInitialUpdate (false) { addAndMakeVisible (viewport = new ListViewport (*this)); ListBox::setWantsKeyboardFocus (true); ListBox::colourChanged(); } ListBox::~ListBox() { headerComponent = nullptr; viewport = nullptr; } void ListBox::setModel (ListBoxModel* const newModel) { if (model != newModel) { model = newModel; repaint(); updateContent(); } } void ListBox::setMultipleSelectionEnabled (bool b) { multipleSelection = b; } void ListBox::setMouseMoveSelectsRows (bool b) { if (b) { if (mouseMoveSelector == nullptr) mouseMoveSelector = new ListBoxMouseMoveSelector (*this); } else { mouseMoveSelector = nullptr; } } //============================================================================== void ListBox::paint (Graphics& g) { if (! hasDoneInitialUpdate) updateContent(); g.fillAll (findColour (backgroundColourId)); } void ListBox::paintOverChildren (Graphics& g) { if (outlineThickness > 0) { g.setColour (findColour (outlineColourId)); g.drawRect (getLocalBounds(), outlineThickness); } } void ListBox::resized() { viewport->setBoundsInset (BorderSize (outlineThickness + (headerComponent != nullptr ? headerComponent->getHeight() : 0), outlineThickness, outlineThickness, outlineThickness)); viewport->setSingleStepSizes (20, getRowHeight()); viewport->updateVisibleArea (false); } void ListBox::visibilityChanged() { viewport->updateVisibleArea (true); } Viewport* ListBox::getViewport() const noexcept { return viewport; } //============================================================================== void ListBox::updateContent() { hasDoneInitialUpdate = true; totalItems = (model != nullptr) ? model->getNumRows() : 0; bool selectionChanged = false; if (selected.size() > 0 && selected [selected.size() - 1] >= totalItems) { selected.removeRange (Range (totalItems, std::numeric_limits::max())); lastRowSelected = getSelectedRow (0); selectionChanged = true; } viewport->updateVisibleArea (isVisible()); viewport->resized(); if (selectionChanged && model != nullptr) model->selectedRowsChanged (lastRowSelected); } //============================================================================== void ListBox::selectRow (const int row, bool dontScroll, bool deselectOthersFirst) { selectRowInternal (row, dontScroll, deselectOthersFirst, false); } void ListBox::selectRowInternal (const int row, bool dontScroll, bool deselectOthersFirst, bool isMouseClick) { if (! multipleSelection) deselectOthersFirst = true; if ((! isRowSelected (row)) || (deselectOthersFirst && getNumSelectedRows() > 1)) { if (isPositiveAndBelow (row, totalItems)) { if (deselectOthersFirst) selected.clear(); selected.addRange (Range (row, row + 1)); if (getHeight() == 0 || getWidth() == 0) dontScroll = true; viewport->selectRow (row, getRowHeight(), dontScroll, lastRowSelected, totalItems, isMouseClick); lastRowSelected = row; model->selectedRowsChanged (row); } else { if (deselectOthersFirst) deselectAllRows(); } } } void ListBox::deselectRow (const int row) { if (selected.contains (row)) { selected.removeRange (Range (row, row + 1)); if (row == lastRowSelected) lastRowSelected = getSelectedRow (0); viewport->updateContents(); model->selectedRowsChanged (lastRowSelected); } } void ListBox::setSelectedRows (const SparseSet& setOfRowsToBeSelected, const NotificationType sendNotificationEventToModel) { selected = setOfRowsToBeSelected; selected.removeRange (Range (totalItems, std::numeric_limits::max())); if (! isRowSelected (lastRowSelected)) lastRowSelected = getSelectedRow (0); viewport->updateContents(); if (model != nullptr && sendNotificationEventToModel == sendNotification) model->selectedRowsChanged (lastRowSelected); } SparseSet ListBox::getSelectedRows() const { return selected; } void ListBox::selectRangeOfRows (int firstRow, int lastRow) { if (multipleSelection && (firstRow != lastRow)) { const int numRows = totalItems - 1; firstRow = jlimit (0, jmax (0, numRows), firstRow); lastRow = jlimit (0, jmax (0, numRows), lastRow); selected.addRange (Range (jmin (firstRow, lastRow), jmax (firstRow, lastRow) + 1)); selected.removeRange (Range (lastRow, lastRow + 1)); } selectRowInternal (lastRow, false, false, true); } void ListBox::flipRowSelection (const int row) { if (isRowSelected (row)) deselectRow (row); else selectRowInternal (row, false, false, true); } void ListBox::deselectAllRows() { if (! selected.isEmpty()) { selected.clear(); lastRowSelected = -1; viewport->updateContents(); if (model != nullptr) model->selectedRowsChanged (lastRowSelected); } } void ListBox::selectRowsBasedOnModifierKeys (const int row, ModifierKeys mods, const bool isMouseUpEvent) { if (multipleSelection && mods.isCommandDown()) { flipRowSelection (row); } else if (multipleSelection && mods.isShiftDown() && lastRowSelected >= 0) { selectRangeOfRows (lastRowSelected, row); } else if ((! mods.isPopupMenu()) || ! isRowSelected (row)) { selectRowInternal (row, false, ! (multipleSelection && (! isMouseUpEvent) && isRowSelected (row)), true); } } int ListBox::getNumSelectedRows() const { return selected.size(); } int ListBox::getSelectedRow (const int index) const { return (isPositiveAndBelow (index, selected.size())) ? selected [index] : -1; } bool ListBox::isRowSelected (const int row) const { return selected.contains (row); } int ListBox::getLastRowSelected() const { return isRowSelected (lastRowSelected) ? lastRowSelected : -1; } //============================================================================== int ListBox::getRowContainingPosition (const int x, const int y) const noexcept { if (isPositiveAndBelow (x, getWidth())) { const int row = (viewport->getViewPositionY() + y - viewport->getY()) / rowHeight; if (isPositiveAndBelow (row, totalItems)) return row; } return -1; } int ListBox::getInsertionIndexForPosition (const int x, const int y) const noexcept { if (isPositiveAndBelow (x, getWidth())) { const int row = (viewport->getViewPositionY() + y + rowHeight / 2 - viewport->getY()) / rowHeight; return jlimit (0, totalItems, row); } return -1; } Component* ListBox::getComponentForRowNumber (const int row) const noexcept { if (RowComponent* const listRowComp = viewport->getComponentForRowIfOnscreen (row)) return static_cast (listRowComp->customComponent); return nullptr; } int ListBox::getRowNumberOfComponent (Component* const rowComponent) const noexcept { return viewport->getRowNumberOfComponent (rowComponent); } Rectangle ListBox::getRowPosition (const int rowNumber, const bool relativeToComponentTopLeft) const noexcept { int y = viewport->getY() + rowHeight * rowNumber; if (relativeToComponentTopLeft) y -= viewport->getViewPositionY(); return Rectangle (viewport->getX(), y, viewport->getViewedComponent()->getWidth(), rowHeight); } void ListBox::setVerticalPosition (const double proportion) { const int offscreen = viewport->getViewedComponent()->getHeight() - viewport->getHeight(); viewport->setViewPosition (viewport->getViewPositionX(), jmax (0, roundToInt (proportion * offscreen))); } double ListBox::getVerticalPosition() const { const int offscreen = viewport->getViewedComponent()->getHeight() - viewport->getHeight(); return (offscreen > 0) ? viewport->getViewPositionY() / (double) offscreen : 0; } int ListBox::getVisibleRowWidth() const noexcept { return viewport->getViewWidth(); } void ListBox::scrollToEnsureRowIsOnscreen (const int row) { viewport->scrollToEnsureRowIsOnscreen (row, getRowHeight()); } //============================================================================== bool ListBox::keyPressed (const KeyPress& key) { const int numVisibleRows = viewport->getHeight() / getRowHeight(); const bool multiple = multipleSelection && lastRowSelected >= 0 && key.getModifiers().isShiftDown(); if (key.isKeyCode (KeyPress::upKey)) { if (multiple) selectRangeOfRows (lastRowSelected, lastRowSelected - 1); else selectRow (jmax (0, lastRowSelected - 1)); } else if (key.isKeyCode (KeyPress::downKey)) { if (multiple) selectRangeOfRows (lastRowSelected, lastRowSelected + 1); else selectRow (jmin (totalItems - 1, jmax (0, lastRowSelected) + 1)); } else if (key.isKeyCode (KeyPress::pageUpKey)) { if (multiple) selectRangeOfRows (lastRowSelected, lastRowSelected - numVisibleRows); else selectRow (jmax (0, jmax (0, lastRowSelected) - numVisibleRows)); } else if (key.isKeyCode (KeyPress::pageDownKey)) { if (multiple) selectRangeOfRows (lastRowSelected, lastRowSelected + numVisibleRows); else selectRow (jmin (totalItems - 1, jmax (0, lastRowSelected) + numVisibleRows)); } else if (key.isKeyCode (KeyPress::homeKey)) { if (multiple) selectRangeOfRows (lastRowSelected, 0); else selectRow (0); } else if (key.isKeyCode (KeyPress::endKey)) { if (multiple) selectRangeOfRows (lastRowSelected, totalItems - 1); else selectRow (totalItems - 1); } else if (key.isKeyCode (KeyPress::returnKey) && isRowSelected (lastRowSelected)) { if (model != nullptr) model->returnKeyPressed (lastRowSelected); } else if ((key.isKeyCode (KeyPress::deleteKey) || key.isKeyCode (KeyPress::backspaceKey)) && isRowSelected (lastRowSelected)) { if (model != nullptr) model->deleteKeyPressed (lastRowSelected); } else if (multipleSelection && key == KeyPress ('a', ModifierKeys::commandModifier, 0)) { selectRangeOfRows (0, std::numeric_limits::max()); } else { return false; } return true; } bool ListBox::keyStateChanged (const bool isKeyDown) { return isKeyDown && (KeyPress::isKeyCurrentlyDown (KeyPress::upKey) || KeyPress::isKeyCurrentlyDown (KeyPress::pageUpKey) || KeyPress::isKeyCurrentlyDown (KeyPress::downKey) || KeyPress::isKeyCurrentlyDown (KeyPress::pageDownKey) || KeyPress::isKeyCurrentlyDown (KeyPress::homeKey) || KeyPress::isKeyCurrentlyDown (KeyPress::endKey) || KeyPress::isKeyCurrentlyDown (KeyPress::returnKey)); } void ListBox::mouseWheelMove (const MouseEvent& e, const MouseWheelDetails& wheel) { bool eventWasUsed = false; if (wheel.deltaX != 0 && viewport->getHorizontalScrollBar()->isVisible()) { eventWasUsed = true; viewport->getHorizontalScrollBar()->mouseWheelMove (e, wheel); } if (wheel.deltaY != 0 && viewport->getVerticalScrollBar()->isVisible()) { eventWasUsed = true; viewport->getVerticalScrollBar()->mouseWheelMove (e, wheel); } if (! eventWasUsed) Component::mouseWheelMove (e, wheel); } void ListBox::mouseUp (const MouseEvent& e) { if (e.mouseWasClicked() && model != nullptr) model->backgroundClicked(); } //============================================================================== void ListBox::setRowHeight (const int newHeight) { rowHeight = jmax (1, newHeight); viewport->setSingleStepSizes (20, rowHeight); updateContent(); } int ListBox::getNumRowsOnScreen() const noexcept { return viewport->getMaximumVisibleHeight() / rowHeight; } void ListBox::setMinimumContentWidth (const int newMinimumWidth) { minimumRowWidth = newMinimumWidth; updateContent(); } int ListBox::getVisibleContentWidth() const noexcept { return viewport->getMaximumVisibleWidth(); } ScrollBar* ListBox::getVerticalScrollBar() const noexcept { return viewport->getVerticalScrollBar(); } ScrollBar* ListBox::getHorizontalScrollBar() const noexcept { return viewport->getHorizontalScrollBar(); } void ListBox::colourChanged() { setOpaque (findColour (backgroundColourId).isOpaque()); viewport->setOpaque (isOpaque()); repaint(); } void ListBox::setOutlineThickness (const int newThickness) { outlineThickness = newThickness; resized(); } void ListBox::setHeaderComponent (Component* const newHeaderComponent) { if (headerComponent != newHeaderComponent) { headerComponent = newHeaderComponent; addAndMakeVisible (newHeaderComponent); ListBox::resized(); } } void ListBox::repaintRow (const int rowNumber) noexcept { repaint (getRowPosition (rowNumber, true)); } Image ListBox::createSnapshotOfSelectedRows (int& imageX, int& imageY) { Rectangle imageArea; const int firstRow = getRowContainingPosition (0, 0); for (int i = getNumRowsOnScreen() + 2; --i >= 0;) { Component* rowComp = viewport->getComponentForRowIfOnscreen (firstRow + i); if (rowComp != nullptr && isRowSelected (firstRow + i)) { const Point pos (getLocalPoint (rowComp, Point())); const Rectangle rowRect (pos.getX(), pos.getY(), rowComp->getWidth(), rowComp->getHeight()); imageArea = imageArea.getUnion (rowRect); } } imageArea = imageArea.getIntersection (getLocalBounds()); imageX = imageArea.getX(); imageY = imageArea.getY(); Image snapshot (Image::ARGB, imageArea.getWidth(), imageArea.getHeight(), true); for (int i = getNumRowsOnScreen() + 2; --i >= 0;) { Component* rowComp = viewport->getComponentForRowIfOnscreen (firstRow + i); if (rowComp != nullptr && isRowSelected (firstRow + i)) { Graphics g (snapshot); g.setOrigin (getLocalPoint (rowComp, Point()) - imageArea.getPosition()); if (g.reduceClipRegion (rowComp->getLocalBounds())) { g.beginTransparencyLayer (0.6f); rowComp->paintEntireComponent (g, false); g.endTransparencyLayer(); } } } return snapshot; } void ListBox::startDragAndDrop (const MouseEvent& e, const var& dragDescription, bool allowDraggingToOtherWindows) { if (DragAndDropContainer* const dragContainer = DragAndDropContainer::findParentDragContainerFor (this)) { int x, y; Image dragImage (createSnapshotOfSelectedRows (x, y)); MouseEvent e2 (e.getEventRelativeTo (this)); const Point p (x - e2.x, y - e2.y); dragContainer->startDragging (dragDescription, this, dragImage, allowDraggingToOtherWindows, &p); } else { // to be able to do a drag-and-drop operation, the listbox needs to // be inside a component which is also a DragAndDropContainer. jassertfalse; } } //============================================================================== Component* ListBoxModel::refreshComponentForRow (int, bool, Component* existingComponentToUpdate) { (void) existingComponentToUpdate; jassert (existingComponentToUpdate == nullptr); // indicates a failure in the code that recycles the components return nullptr; } void ListBoxModel::listBoxItemClicked (int, const MouseEvent&) {} void ListBoxModel::listBoxItemDoubleClicked (int, const MouseEvent&) {} void ListBoxModel::backgroundClicked() {} void ListBoxModel::selectedRowsChanged (int) {} void ListBoxModel::deleteKeyPressed (int) {} void ListBoxModel::returnKeyPressed (int) {} void ListBoxModel::listWasScrolled() {} var ListBoxModel::getDragSourceDescription (const SparseSet&) { return var::null; } String ListBoxModel::getTooltipForRow (int) { return String::empty; }