openshot-audio  0.1.7
Classes | Public Types | Public Member Functions | List of all members
TableHeaderComponent Class Reference

#include <juce_TableHeaderComponent.h>

Inheritance diagram for TableHeaderComponent:
Component AsyncUpdater MouseListener TableListBox::Header

Classes

class  DragOverlayComp
 
class  Listener
 
struct  LookAndFeelMethods
 

Public Types

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)
}
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 

Public Member Functions

 TableHeaderComponent ()
 
 ~TableHeaderComponent ()
 
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)
 
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)
 
void paint (Graphics &) override
 
void resized () 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)
 
- Public Member Functions inherited from Component
 Component () noexcept
 
virtual ~Component ()
 
 Component (const String &componentName) noexcept
 
const StringgetName () const noexcept
 
virtual void setName (const String &newName)
 
const StringgetComponentID () const noexcept
 
void setComponentID (const String &newID)
 
virtual void setVisible (bool shouldBeVisible)
 
bool isVisible () const noexcept
 
virtual void visibilityChanged ()
 
bool isShowing () const
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 
void removeFromDesktop ()
 
bool isOnDesktop () const noexcept
 
ComponentPeergetPeer () const
 
virtual void userTriedToCloseWindow ()
 
virtual void minimisationStateChanged (bool isNowMinimised)
 
virtual float getDesktopScaleFactor () const
 
void toFront (bool shouldAlsoGainFocus)
 
void toBack ()
 
void toBehind (Component *other)
 
void setAlwaysOnTop (bool shouldStayOnTop)
 
bool isAlwaysOnTop () const noexcept
 
int getX () const noexcept
 
int getY () const noexcept
 
int getWidth () const noexcept
 
int getHeight () const noexcept
 
int getRight () const noexcept
 
Point< int > getPosition () const noexcept
 
int getBottom () const noexcept
 
const Rectangle< int > & getBounds () const noexcept
 
Rectangle< int > getLocalBounds () const noexcept
 
Rectangle< int > getBoundsInParent () const noexcept
 
int getScreenX () const
 
int getScreenY () const
 
Point< int > getScreenPosition () const
 
Rectangle< int > getScreenBounds () const
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 
Rectangle< int > getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &localArea) const
 
void setTopLeftPosition (int x, int y)
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 
void setTopRightPosition (int x, int y)
 
void setSize (int newWidth, int newHeight)
 
void setBounds (int x, int y, int width, int height)
 
void setBounds (const Rectangle< int > &newBounds)
 
void setBounds (const RelativeRectangle &newBounds)
 
void setBounds (const String &newBoundsExpression)
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 
void setBoundsInset (const BorderSize< int > &borders)
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 
void setCentrePosition (int x, int y)
 
void setCentreRelative (float x, float y)
 
void centreWithSize (int width, int height)
 
void setTransform (const AffineTransform &transform)
 
AffineTransform getTransform () const
 
bool isTransformed () const noexcept
 
int proportionOfWidth (float proportion) const noexcept
 
int proportionOfHeight (float proportion) const noexcept
 
int getParentWidth () const noexcept
 
int getParentHeight () const noexcept
 
Rectangle< int > getParentMonitorArea () const
 
int getNumChildComponents () const noexcept
 
ComponentgetChildComponent (int index) const noexcept
 
int getIndexOfChildComponent (const Component *child) const noexcept
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 
void addChildComponent (Component *child, int zOrder=-1)
 
void addChildComponent (Component &child, int zOrder=-1)
 
void addAndMakeVisible (Component *child, int zOrder=-1)
 
void addAndMakeVisible (Component &child, int zOrder=-1)
 
void addChildAndSetID (Component *child, const String &componentID)
 
void removeChildComponent (Component *childToRemove)
 
ComponentremoveChildComponent (int childIndexToRemove)
 
void removeAllChildren ()
 
void deleteAllChildren ()
 
ComponentgetParentComponent () const noexcept
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 
ComponentgetTopLevelComponent () const noexcept
 
bool isParentOf (const Component *possibleChild) const noexcept
 
virtual void parentHierarchyChanged ()
 
virtual void childrenChanged ()
 
virtual bool hitTest (int x, int y)
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 
bool contains (Point< int > localPoint)
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 
ComponentgetComponentAt (int x, int y)
 
ComponentgetComponentAt (Point< int > position)
 
void repaint ()
 
void repaint (int x, int y, int width, int height)
 
void repaint (const Rectangle< int > &area)
 
void setBufferedToImage (bool shouldBeBuffered)
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 
void setComponentEffect (ImageEffectFilter *newEffect)
 
ImageEffectFiltergetComponentEffect () const noexcept
 
LookAndFeelgetLookAndFeel () const noexcept
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 
virtual void lookAndFeelChanged ()
 
void sendLookAndFeelChange ()
 
void setOpaque (bool shouldBeOpaque)
 
bool isOpaque () const noexcept
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 
bool isBroughtToFrontOnMouseClick () const noexcept
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 
bool getWantsKeyboardFocus () const noexcept
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 
void grabKeyboardFocus ()
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 
void moveKeyboardFocusToSibling (bool moveToNext)
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 
int getExplicitFocusOrder () const
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 
bool isFocusContainer () const noexcept
 
bool isEnabled () const noexcept
 
void setEnabled (bool shouldBeEnabled)
 
virtual void enablementChanged ()
 
void setAlpha (float newAlpha)
 
float getAlpha () const
 
void setMouseCursor (const MouseCursor &cursorType)
 
void updateMouseCursor () const
 
virtual void paintOverChildren (Graphics &g)
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 
void removeMouseListener (MouseListener *listenerToRemove)
 
void addKeyListener (KeyListener *newListener)
 
void removeKeyListener (KeyListener *listenerToRemove)
 
virtual bool keyPressed (const KeyPress &key)
 
virtual bool keyStateChanged (bool isKeyDown)
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 
virtual void focusGained (FocusChangeType cause)
 
virtual void focusLost (FocusChangeType cause)
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 
bool isMouseOver (bool includeChildren=false) const
 
bool isMouseButtonDown () const
 
bool isMouseOverOrDragging () const
 
Point< int > getMouseXYRelative () const
 
virtual void moved ()
 
virtual void childBoundsChanged (Component *child)
 
virtual void parentSizeChanged ()
 
virtual void broughtToFront ()
 
void addComponentListener (ComponentListener *newListener)
 
void removeComponentListener (ComponentListener *listenerToRemove)
 
void postCommandMessage (int commandId)
 
virtual void handleCommandMessage (int commandId)
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 
void exitModalState (int returnValue)
 
bool isCurrentlyModal () const noexcept
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 
virtual void inputAttemptWhenModal ()
 
NamedValueSetgetProperties () noexcept
 
const NamedValueSetgetProperties () const noexcept
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 
void setColour (int colourId, Colour newColour)
 
void removeColour (int colourId)
 
bool isColourSpecified (int colourId) const
 
void copyAllExplicitColoursTo (Component &target) const
 
virtual void colourChanged ()
 
virtual MarkerListgetMarkers (bool xAxis)
 
void * getWindowHandle () const
 
PositionergetPositioner () const noexcept
 
void setPositioner (Positioner *newPositioner)
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 
CachedComponentImagegetCachedComponentImage () const noexcept
 
 JUCE_DEPRECATED (Point< int > relativePositionToGlobal(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > globalPositionToRelative(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > relativePositionToOtherComponent(const Component *, Point< int >) const)
 
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Component
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks)
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 
- Protected Member Functions inherited from Component
virtual ComponentPeercreateNewPeer (int styleFlags, void *nativeWindowToAttachTo)
 

Detailed Description

A component that displays a strip of column headings for a table, and allows these to be resized, dragged around, etc.

This is just the component that goes at the top of a table. You can use it directly for custom components, or to create a simple table, use the TableListBox class.

To use one of these, create it and use addColumn() to add all the columns that you need. Each column must be given a unique ID number that's used to refer to it.

See also
TableListBox, TableHeaderComponent::Listener

Member Enumeration Documentation

◆ ColumnPropertyFlags

A combination of these flags are passed into the addColumn() method to specify the properties of a column.

Enumerator
visible 

If this is set, the column will be shown; if not, it will be hidden until the user enables it with the pop-up menu.

resizable 

If this is set, the column can be resized by dragging it.

draggable 

If this is set, the column can be dragged around to change its order in the table.

appearsOnColumnMenu 

If this is set, the column will be shown on the pop-up menu allowing it to be hidden/shown.

sortable 

If this is set, then clicking on the column header will set it to be the sort column, and clicking again will reverse the order.

sortedForwards 

If this is set, the column is currently the one by which the table is sorted (forwards).

sortedBackwards 

If this is set, the column is currently the one by which the table is sorted (backwards).

defaultFlags 

This set of default flags is used as the default parameter value in addColumn().

notResizable 

A quick way of combining flags for a column that's not resizable.

notResizableOrSortable 

A quick way of combining flags for a column that's not resizable or sortable.

notSortable 

A quick way of combining flags for a column that's not sortable.

Constructor & Destructor Documentation

◆ TableHeaderComponent()

TableHeaderComponent::TableHeaderComponent ( )

Creates an empty table header.

◆ ~TableHeaderComponent()

TableHeaderComponent::~TableHeaderComponent ( )

Destructor.

Member Function Documentation

◆ addColumn()

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

Adds a column to the table.

This will add a column, and asynchronously call the tableColumnsChanged() method of any registered listeners.

Parameters
columnNamethe name of the new column. It's ok to have two or more columns with the same name
columnIdan ID for this column. The ID can be any number apart from 0, but every column must have a unique ID. This is used to identify the column later on, after the user may have changed the order that they appear in
widththe initial width of the column, in pixels
maximumWidtha maximum width that the column can take when the user is resizing it. This only applies if the 'resizable' flag is specified for this column
minimumWidtha minimum width that the column can take when the user is resizing it. This only applies if the 'resizable' flag is specified for this column
propertyFlagsa combination of some of the values from the ColumnPropertyFlags enum, to define the properties of this column
insertIndexthe index at which the column should be added. A value of 0 puts it at the start (left-hand side) and -1 puts it at the end (right-hand size) of the table. Note that the index the index within all columns, not just the index amongst those that are currently visible

◆ addListener()

void TableHeaderComponent::addListener ( Listener newListener)

Adds a listener to be informed about things that happen to the header.

◆ addMenuItems()

void TableHeaderComponent::addMenuItems ( PopupMenu menu,
int  columnIdClicked 
)
virtual

This can be overridden to add custom items to the pop-up menu.

If you override this, you should call the superclass's method to add its column show/hide items, if you want them on the menu as well.

Then to handle the result, override reactToMenuItem().

See also
reactToMenuItem

Reimplemented in TableListBox::Header.

◆ columnClicked()

void TableHeaderComponent::columnClicked ( int  columnId,
const ModifierKeys mods 
)
virtual

This can be overridden to handle a mouse-click on one of the column headers.

The default implementation will use this click to call getSortColumnId() and change the sort order.

◆ getColumnIdAtX()

int TableHeaderComponent::getColumnIdAtX ( int  xToFind) const

Finds the column ID at a given x-position in the component. If there is a column at this point this returns its ID, or if not, it will return 0.

◆ getColumnIdOfIndex()

int TableHeaderComponent::getColumnIdOfIndex ( int  index,
bool  onlyCountVisibleColumns 
) const

Returns the ID of the column at a given index.

If onlyCountVisibleColumns is true, this will count the index amoungst the visible columns; otherwise it'll count it amongst all the columns, including any hidden ones.

If the index is out-of-range, it'll return 0.

◆ getColumnName()

String TableHeaderComponent::getColumnName ( int  columnId) const

Returns the name for a column.

See also
setColumnName

◆ getColumnPosition()

Rectangle< int > TableHeaderComponent::getColumnPosition ( int  index) const

Returns the rectangle containing of one of the columns.

The index is an index from 0 to the number of columns that are currently visible (hidden ones are not counted). It returns a rectangle showing the position of the column relative to this component's top-left. If the index is out-of-range, an empty rectangle is retrurned.

◆ getColumnWidth()

int TableHeaderComponent::getColumnWidth ( int  columnId) const

Returns the width of one of the columns.

◆ getIndexOfColumnId()

int TableHeaderComponent::getIndexOfColumnId ( int  columnId,
bool  onlyCountVisibleColumns 
) const

Returns the index of a given column.

If there's no such column ID, this will return -1.

If onlyCountVisibleColumns is true, this will return the index amoungst the visible columns; otherwise it'll return the index amongst all the columns, including any hidden ones.

◆ getMouseCursor()

MouseCursor TableHeaderComponent::getMouseCursor ( )
overridevirtual

Returns the mouse cursor shape to use when the mouse is over this component.

The default implementation will return the cursor that was set by setCursor() but can be overridden for more specialised purposes, e.g. returning different cursors depending on the mouse position.

See also
MouseCursor

Reimplemented from Component.

◆ getNumColumns()

int TableHeaderComponent::getNumColumns ( bool  onlyCountVisibleColumns) const

Returns the number of columns in the table.

If onlyCountVisibleColumns is true, this will return the number of visible columns; otherwise it'll return the total number of columns, including hidden ones.

See also
isColumnVisible

◆ getSortColumnId()

int TableHeaderComponent::getSortColumnId ( ) const

Returns the column ID by which the table is currently sorted, or 0 if it is unsorted.

See also
setSortColumnId, isSortedForwards

◆ getTotalWidth()

int TableHeaderComponent::getTotalWidth ( ) const

Returns the total width of all the visible columns in the table.

◆ isColumnVisible()

bool TableHeaderComponent::isColumnVisible ( int  columnId) const

Returns true if this column is currently visible.

See also
setColumnVisible

◆ isPopupMenuActive()

bool TableHeaderComponent::isPopupMenuActive ( ) const

Returns true if the pop-up menu is enabled.

See also
setPopupMenuActive

◆ isSortedForwards()

bool TableHeaderComponent::isSortedForwards ( ) const

Returns true if the table is currently sorted forwards, or false if it's backwards.

See also
setSortColumnId

◆ isStretchToFitActive()

bool TableHeaderComponent::isStretchToFitActive ( ) const

Returns true if stretch-to-fit has been enabled.

See also
setStretchToFitActive

◆ mouseDown()

void TableHeaderComponent::mouseDown ( const MouseEvent event)
overridevirtual

Called when a mouse button is pressed.

The MouseEvent object passed in contains lots of methods for finding out which button was pressed, as well as which modifier keys (e.g. shift, ctrl) were held down at the time.

Once a button is held down, the mouseDrag method will be called when the mouse moves, until the button is released.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseUp, mouseDrag, mouseDoubleClick, contains

Reimplemented from Component.

◆ mouseDrag()

void TableHeaderComponent::mouseDrag ( const MouseEvent event)
overridevirtual

Called when the mouse is moved while a button is held down.

When a mouse button is pressed inside a component, that component receives mouseDrag callbacks each time the mouse moves, even if the mouse strays outside the component's bounds.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseDown, mouseUp, mouseMove, contains, setDragRepeatInterval

Reimplemented from Component.

◆ mouseEnter()

void TableHeaderComponent::mouseEnter ( const MouseEvent event)
overridevirtual

Called when the mouse first enters a component.

If the mouse button isn't pressed and the mouse moves into a component, this will be called to let the component react to this.

When the mouse button is pressed and held down while being moved in or out of a component, no mouseEnter or mouseExit callbacks are made - only mouseDrag messages are sent to the component that the mouse was originally clicked on, until the button is released.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseExit, mouseDrag, mouseMove, contains

Reimplemented from Component.

◆ mouseExit()

void TableHeaderComponent::mouseExit ( const MouseEvent event)
overridevirtual

Called when the mouse moves out of a component.

This will be called when the mouse moves off the edge of this component.

If the mouse button was pressed, and it was then dragged off the edge of the component and released, then this callback will happen when the button is released, after the mouseUp callback.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseEnter, mouseDrag, mouseMove, contains

Reimplemented from Component.

◆ mouseMove()

void TableHeaderComponent::mouseMove ( const MouseEvent event)
overridevirtual

Called when the mouse moves inside a component.

If the mouse button isn't pressed and the mouse moves over a component, this will be called to let the component react to this.

A component will always get a mouseEnter callback before a mouseMove.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseEnter, mouseExit, mouseDrag, contains

Reimplemented from Component.

◆ mouseUp()

void TableHeaderComponent::mouseUp ( const MouseEvent event)
overridevirtual

Called when a mouse button is released.

A mouseUp callback is sent to the component in which a button was pressed even if the mouse is actually over a different component when the button is released.

The MouseEvent object passed in contains lots of methods for finding out which buttons were down just before they were released.

Parameters
eventdetails about the position and status of the mouse event, including the source component in which it occurred
See also
mouseDown, mouseDrag, mouseDoubleClick, contains

Reimplemented from Component.

◆ moveColumn()

void TableHeaderComponent::moveColumn ( int  columnId,
int  newVisibleIndex 
)

Moves a column to a different index in the table.

Parameters
columnIdthe column to move
newVisibleIndexthe target index for it, from 0 to the number of columns currently visible.

◆ paint()

void TableHeaderComponent::paint ( Graphics g)
overridevirtual

Components can override this method to draw their content.

The paint() method gets called when a region of a component needs redrawing, either because the component's repaint() method has been called, or because something has happened on the screen that means a section of a window needs to be redrawn.

Any child components will draw themselves over whatever this method draws. If you need to paint over the top of your child components, you can also implement the paintOverChildren() method to do this.

If you want to cause a component to redraw itself, this is done asynchronously - calling the repaint() method marks a region of the component as "dirty", and the paint() method will automatically be called sometime later, by the message thread, to paint any bits that need refreshing. In Juce (and almost all modern UI frameworks), you never redraw something synchronously.

You should never need to call this method directly - to take a snapshot of the component you could use createComponentSnapshot() or paintEntireComponent().

Parameters
gthe graphics context that must be used to do the drawing operations.
See also
repaint, paintOverChildren, Graphics

Reimplemented from Component.

◆ reactToMenuItem()

void TableHeaderComponent::reactToMenuItem ( int  menuReturnId,
int  columnIdClicked 
)
virtual

Override this to handle any custom items that you have added to the pop-up menu with an addMenuItems() override.

If the menuReturnId isn't one of your own custom menu items, you'll need to call TableHeaderComponent::reactToMenuItem() to allow the base class to handle the items that it had added.

See also
addMenuItems

Reimplemented in TableListBox::Header.

◆ removeAllColumns()

void TableHeaderComponent::removeAllColumns ( )

Deletes all columns from the table.

If there are any columns to remove, this will asynchronously call the tableColumnsChanged() method of any registered listeners.

◆ removeColumn()

void TableHeaderComponent::removeColumn ( int  columnIdToRemove)

Removes a column with the given ID.

If there is such a column, this will asynchronously call the tableColumnsChanged() method of any registered listeners.

◆ removeListener()

void TableHeaderComponent::removeListener ( Listener listenerToRemove)

Removes a previously-registered listener.

◆ resizeAllColumnsToFit()

void TableHeaderComponent::resizeAllColumnsToFit ( int  targetTotalWidth)

If stretch-to-fit is enabled, this will resize all the columns to make them fit into the specified width, keeping their relative proportions the same.

If the minimum widths of the columns are too wide to fit into this space, it may actually end up wider.

◆ resized()

void TableHeaderComponent::resized ( )
overridevirtual

Called when this component's size has been changed.

A component can implement this method to do things such as laying out its child components when its width or height changes.

The method is called synchronously as a result of the setBounds or setSize methods, so repeatedly changing a components size will repeatedly call its resized method (unlike things like repainting, where multiple calls to repaint are coalesced together).

If the component is a top-level window on the desktop, its size could also be changed by operating-system factors beyond the application's control.

See also
moved, setSize

Reimplemented from Component.

◆ reSortTable()

void TableHeaderComponent::reSortTable ( )

Triggers a re-sort of the table according to the current sort-column.

If you modifiy the table's contents, you can call this to signal that the table needs to be re-sorted.

(This doesn't do any sorting synchronously - it just asynchronously sends a call to the tableSortOrderChanged() method of any listeners).

◆ restoreFromString()

void TableHeaderComponent::restoreFromString ( const String storedVersion)

Restores the state of the table, based on a string previously created with toString().

See also
toString

◆ setColumnName()

void TableHeaderComponent::setColumnName ( int  columnId,
const String newName 
)

Changes the name of a column.

◆ setColumnVisible()

void TableHeaderComponent::setColumnVisible ( int  columnId,
bool  shouldBeVisible 
)

Shows or hides a column.

This can cause an asynchronous callback to the tableColumnsChanged() method of any registered listeners.

See also
isColumnVisible

◆ setColumnWidth()

void TableHeaderComponent::setColumnWidth ( int  columnId,
int  newWidth 
)

Changes the width of a column.

This will cause an asynchronous callback to the tableColumnsResized() method of any registered listeners.

◆ setPopupMenuActive()

void TableHeaderComponent::setPopupMenuActive ( bool  hasMenu)

Enables or disables the pop-up menu.

The default menu allows the user to show or hide columns. You can add custom items to this menu by overloading the addMenuItems() and reactToMenuItem() methods.

By default the menu is enabled.

See also
isPopupMenuActive, addMenuItems, reactToMenuItem

◆ setSortColumnId()

void TableHeaderComponent::setSortColumnId ( int  columnId,
bool  sortForwards 
)

Changes the column which is the sort column.

This can cause an asynchronous callback to the tableSortOrderChanged() method of any registered listeners.

If this method doesn't actually change the column ID, then no re-sort will take place (you can call reSortTable() to force a re-sort to happen if you've modified the table's contents).

See also
getSortColumnId, isSortedForwards, reSortTable

◆ setStretchToFitActive()

void TableHeaderComponent::setStretchToFitActive ( bool  shouldStretchToFit)

If set to true, this indicates that the columns should be expanded or shrunk to fill the entire width of the component.

By default this is disabled. Turning it on also means that when resizing a column, those on the right will be squashed to fit.

◆ showColumnChooserMenu()

void TableHeaderComponent::showColumnChooserMenu ( int  columnIdClicked)
virtual

Can be overridden for more control over the pop-up menu behaviour.

◆ toString()

String TableHeaderComponent::toString ( ) const

Returns a string that encapsulates the table's current layout.

This can be restored later using restoreFromString(). It saves the order of the columns, the currently-sorted column, and the widths.

See also
restoreFromString

The documentation for this class was generated from the following files: