juce_TableHeaderComponent.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  TableHeaderComponent   : public Component,
                                         private AsyncUpdater
{
public:
    //==============================================================================
    TableHeaderComponent();

    ~TableHeaderComponent() override;
 
    //==============================================================================
    enum ColumnPropertyFlags
    {
        visible                     = 1,    
        resizable                   = 2,    
        draggable                   = 4,    
        appearsOnColumnMenu         = 8,    
        sortable                    = 16,   
        sortedForwards              = 32,   
        sortedBackwards             = 64,   

        defaultFlags                = (visible | resizable | draggable | appearsOnColumnMenu | sortable),

        notResizable                = (visible | draggable | appearsOnColumnMenu | sortable),

        notResizableOrSortable      = (visible | draggable | appearsOnColumnMenu),

        notSortable                 = (visible | resizable | draggable | appearsOnColumnMenu)
    };

    void addColumn (const String& columnName,
                    int columnId,
                    int width,
                    int minimumWidth = 30,
                    int maximumWidth = -1,
                    int propertyFlags = defaultFlags,
                    int insertIndex = -1);

    void removeColumn (int columnIdToRemove);

    void removeAllColumns();

    int getNumColumns (bool onlyCountVisibleColumns) const;

    String getColumnName (int columnId) const;

    void setColumnName (int columnId, const String& newName);

    void moveColumn (int columnId, int newVisibleIndex);

    int getColumnWidth (int columnId) const;

    void setColumnWidth (int columnId, int newWidth);

    void setColumnVisible (int columnId, bool shouldBeVisible);

    bool isColumnVisible (int columnId) const;

    void setSortColumnId (int columnId, bool sortForwards);

    int getSortColumnId() const;

    bool isSortedForwards() const;

    void reSortTable();
 
    //==============================================================================
    int getTotalWidth() const;

    int getIndexOfColumnId (int columnId, bool onlyCountVisibleColumns) const;

    int getColumnIdOfIndex (int index, bool onlyCountVisibleColumns) const;

    Rectangle<int> getColumnPosition (int index) const;

    int getColumnIdAtX (int xToFind) const;

    void setStretchToFitActive (bool shouldStretchToFit);

    bool isStretchToFitActive() const;

    void resizeAllColumnsToFit (int targetTotalWidth);
 
    //==============================================================================
    void setPopupMenuActive (bool hasMenu);

    bool isPopupMenuActive() const;
 
    //==============================================================================
    String toString() const;

    void restoreFromString (const String& storedVersion);
 
    //==============================================================================
    class JUCE_API  Listener
    {
    public:
        //==============================================================================
        Listener() = default;

        virtual ~Listener() = default;
 
        //==============================================================================
        virtual void tableColumnsChanged (TableHeaderComponent* tableHeader) = 0;

        virtual void tableColumnsResized (TableHeaderComponent* tableHeader) = 0;

        virtual void tableSortOrderChanged (TableHeaderComponent* tableHeader) = 0;

        virtual void tableColumnDraggingChanged (TableHeaderComponent* tableHeader,
                                                 int columnIdNowBeingDragged);
    };

    void addListener (Listener* newListener);

    void removeListener (Listener* listenerToRemove);
 
    //==============================================================================
    virtual void columnClicked (int columnId, const ModifierKeys& mods);

    virtual void addMenuItems (PopupMenu& menu, int columnIdClicked);

    virtual void reactToMenuItem (int menuReturnId, int columnIdClicked);
 
    //==============================================================================
    enum ColourIds
    {
        textColourId                   = 0x1003800, 
        backgroundColourId             = 0x1003810, 
        outlineColourId                = 0x1003820, 
        highlightColourId              = 0x1003830, 
    };
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() = default;
 
        virtual void drawTableHeaderBackground (Graphics&, TableHeaderComponent&) = 0;
 
        virtual void drawTableHeaderColumn (Graphics&, TableHeaderComponent&,
                                            const String& columnName, int columnId,
                                            int width, int height,
                                            bool isMouseOver, bool isMouseDown, int columnFlags) = 0;
    };
 
    //==============================================================================
    void paint (Graphics&) override;
    void mouseMove (const MouseEvent&) override;
    void mouseEnter (const MouseEvent&) override;
    void mouseExit (const MouseEvent&) override;
    void mouseDown (const MouseEvent&) override;
    void mouseDrag (const MouseEvent&) override;
    void mouseUp (const MouseEvent&) override;
    MouseCursor getMouseCursor() override;

    virtual void showColumnChooserMenu (int columnIdClicked);
 
private:
    struct ColumnInfo
    {
        String name;
        int id, propertyFlags, width, minimumWidth, maximumWidth;
        double lastDeliberateWidth;
 
        bool isVisible() const;
    };
 
    OwnedArray<ColumnInfo> columns;
    Array<Listener*> listeners;
    std::unique_ptr<Component> dragOverlayComp;
    class DragOverlayComp;
 
    bool columnsChanged = false, columnsResized = false, sortChanged = false;
    bool menuActive = true, stretchToFit = false;
    int columnIdBeingResized = 0, columnIdBeingDragged = 0, initialColumnWidth = 0;
    int columnIdUnderMouse = 0, draggingColumnOffset = 0, draggingColumnOriginalIndex = 0, lastDeliberateWidth = 0;
 
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
    ColumnInfo* getInfoForId (int columnId) const;
    int visibleIndexToTotalIndex (int visibleIndex) const;
    void sendColumnsChanged();
    void handleAsyncUpdate() override;
    void beginDrag (const MouseEvent&);
    void endDrag (int finalIndex);
    int getResizeDraggerAt (int mouseX) const;
    void updateColumnUnderMouse (const MouseEvent&);
    void setColumnUnderMouse (int columnId);
    void resizeColumnsToFit (int firstColumnIndex, int targetTotalWidth);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TableHeaderComponent)
};
 
 
} // namespace juce