JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Types | Public Member Functions | List of all members
TableHeaderComponent Class Reference

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

Inherits Component, and AsyncUpdater.

Classes

class  Listener
 Receives events from a TableHeaderComponent when columns are resized, moved, etc. More...
 
struct  LookAndFeelMethods
 This abstract base class is implemented by LookAndFeel classes. More...
 

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)
}
 A combination of these flags are passed into the addColumn() method to specify the properties of a column. More...
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 Enumeration used by the focusChanged() and focusLost() methods. More...
 

Public Member Functions

 TableHeaderComponent ()
 Creates an empty table header.
 
 ~TableHeaderComponent ()
 Destructor.
 
void 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.
 
void removeColumn (int columnIdToRemove)
 Removes a column with the given ID.
 
void removeAllColumns ()
 Deletes all columns from the table.
 
int getNumColumns (bool onlyCountVisibleColumns) const
 Returns the number of columns in the table.
 
String getColumnName (int columnId) const
 Returns the name for a column.
 
void setColumnName (int columnId, const String &newName)
 Changes the name of a column.
 
void moveColumn (int columnId, int newVisibleIndex)
 Moves a column to a different index in the table.
 
int getColumnWidth (int columnId) const
 Returns the width of one of the columns.
 
void setColumnWidth (int columnId, int newWidth)
 Changes the width of a column.
 
void setColumnVisible (int columnId, bool shouldBeVisible)
 Shows or hides a column.
 
bool isColumnVisible (int columnId) const
 Returns true if this column is currently visible.
 
void setSortColumnId (int columnId, bool sortForwards)
 Changes the column which is the sort column.
 
int getSortColumnId () const
 Returns the column ID by which the table is currently sorted, or 0 if it is unsorted.
 
bool isSortedForwards () const
 Returns true if the table is currently sorted forwards, or false if it's backwards.
 
void reSortTable ()
 Triggers a re-sort of the table according to the current sort-column.
 
int getTotalWidth () const
 Returns the total width of all the visible columns in the table.
 
int getIndexOfColumnId (int columnId, bool onlyCountVisibleColumns) const
 Returns the index of a given column.
 
int getColumnIdOfIndex (int index, bool onlyCountVisibleColumns) const
 Returns the ID of the column at a given index.
 
Rectangle< int > getColumnPosition (int index) const
 Returns the rectangle containing of one of the columns.
 
int getColumnIdAtX (int xToFind) const
 Finds the column ID at a given x-position in the component.
 
void 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.
 
bool isStretchToFitActive () const
 Returns true if stretch-to-fit has been enabled.
 
void 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.
 
void setPopupMenuActive (bool hasMenu)
 Enables or disables the pop-up menu.
 
bool isPopupMenuActive () const
 Returns true if the pop-up menu is enabled.
 
String toString () const
 Returns a string that encapsulates the table's current layout.
 
void restoreFromString (const String &storedVersion)
 Restores the state of the table, based on a string previously created with toString().
 
void addListener (Listener *newListener)
 Adds a listener to be informed about things that happen to the header.
 
void removeListener (Listener *listenerToRemove)
 Removes a previously-registered listener.
 
virtual void columnClicked (int columnId, const ModifierKeys &mods)
 This can be overridden to handle a mouse-click on one of the column headers.
 
virtual void addMenuItems (PopupMenu &menu, int columnIdClicked)
 This can be overridden to add custom items to the pop-up menu.
 
virtual void reactToMenuItem (int menuReturnId, int columnIdClicked)
 Override this to handle any custom items that you have added to the pop-up menu with an addMenuItems() override.
 
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)
 Can be overridden for more control over the pop-up menu behaviour.
 
- Public Member Functions inherited from Component
 Component ()
 Creates a component.
 
virtual ~Component ()
 Destructor.
 
 Component (const String &componentName)
 Creates a component, setting its name at the same time.
 
const StringgetName () const noexcept
 Returns the name of this component.
 
virtual void setName (const String &newName)
 Sets the name of this component.
 
const StringgetComponentID () const noexcept
 Returns the ID string that was set by setComponentID().
 
void setComponentID (const String &newID)
 Sets the component's ID string.
 
virtual void setVisible (bool shouldBeVisible)
 Makes the component visible or invisible.
 
bool isVisible () const noexcept
 Tests whether the component is visible or not.
 
virtual void visibilityChanged ()
 Called when this component's visibility changes.
 
bool isShowing () const
 Tests whether this component and all its parents are visible.
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 Makes this component appear as a window on the desktop.
 
void removeFromDesktop ()
 If the component is currently showing on the desktop, this will hide it.
 
bool isOnDesktop () const noexcept
 Returns true if this component is currently showing on the desktop.
 
ComponentPeergetPeer () const
 Returns the heavyweight window that contains this component.
 
virtual void userTriedToCloseWindow ()
 For components on the desktop, this is called if the system wants to close the window.
 
virtual void minimisationStateChanged (bool isNowMinimised)
 Called for a desktop component which has just been minimised or un-minimised.
 
virtual float getDesktopScaleFactor () const
 Returns the default scale factor to use for this component when it is placed on the desktop.
 
void toFront (bool shouldAlsoGainFocus)
 Brings the component to the front of its siblings.
 
void toBack ()
 Changes this component's z-order to be at the back of all its siblings.
 
void toBehind (Component *other)
 Changes this component's z-order so that it's just behind another component.
 
void setAlwaysOnTop (bool shouldStayOnTop)
 Sets whether the component should always be kept at the front of its siblings.
 
bool isAlwaysOnTop () const noexcept
 Returns true if this component is set to always stay in front of its siblings.
 
int getX () const noexcept
 Returns the x coordinate of the component's left edge.
 
int getY () const noexcept
 Returns the y coordinate of the top of this component.
 
int getWidth () const noexcept
 Returns the component's width in pixels.
 
int getHeight () const noexcept
 Returns the component's height in pixels.
 
int getRight () const noexcept
 Returns the x coordinate of the component's right-hand edge.
 
Point< int > getPosition () const noexcept
 Returns the component's top-left position as a Point.
 
int getBottom () const noexcept
 Returns the y coordinate of the bottom edge of this component.
 
const Rectangle< int > & getBounds () const noexcept
 Returns this component's bounding box.
 
Rectangle< int > getLocalBounds () const noexcept
 Returns the component's bounds, relative to its own origin.
 
Rectangle< int > getBoundsInParent () const noexcept
 Returns the area of this component's parent which this component covers.
 
void getVisibleArea (RectangleList< int > &result, bool includeSiblings) const
 Returns the region of this component that's not obscured by other, opaque components.
 
int getScreenX () const
 Returns this component's x coordinate relative the screen's top-left origin.
 
int getScreenY () const
 Returns this component's y coordinate relative the screen's top-left origin.
 
Point< int > getScreenPosition () const
 Returns the position of this component's top-left corner relative to the screen's top-left.
 
Rectangle< int > getScreenBounds () const
 Returns the bounds of this component, relative to the screen's top-left.
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Rectangle< int > getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space.
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate.
 
void setTopLeftPosition (int x, int y)
 Moves the component to a new position.
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 Moves the component to a new position.
 
void setTopRightPosition (int x, int y)
 Moves the component to a new position.
 
void setSize (int newWidth, int newHeight)
 Changes the size of the component.
 
void setBounds (int x, int y, int width, int height)
 Changes the component's position and size.
 
void setBounds (const Rectangle< int > &newBounds)
 Changes the component's position and size.
 
void setBounds (const RelativeRectangle &newBounds)
 Changes the component's position and size.
 
void setBounds (const String &newBoundsExpression)
 Sets the component's bounds with an expression.
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 Changes the component's position and size in terms of fractions of its parent's size.
 
void setBoundsInset (const BorderSize< int > &borders)
 Changes the component's position and size based on the amount of space to leave around it.
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 Positions the component within a given rectangle, keeping its proportions unchanged.
 
void setCentrePosition (int x, int y)
 Changes the position of the component's centre.
 
void setCentreRelative (float x, float y)
 Changes the position of the component's centre.
 
void centreWithSize (int width, int height)
 Changes the component's size and centres it within its parent.
 
void setTransform (const AffineTransform &transform)
 Sets a transform matrix to be applied to this component.
 
AffineTransform getTransform () const
 Returns the transform that is currently being applied to this component.
 
bool isTransformed () const noexcept
 Returns true if a non-identity transform is being applied to this component.
 
int proportionOfWidth (float proportion) const noexcept
 Returns a proportion of the component's width.
 
int proportionOfHeight (float proportion) const noexcept
 Returns a proportion of the component's height.
 
int getParentWidth () const noexcept
 Returns the width of the component's parent.
 
int getParentHeight () const noexcept
 Returns the height of the component's parent.
 
Rectangle< int > getParentMonitorArea () const
 Returns the screen coordinates of the monitor that contains this component.
 
int getNumChildComponents () const noexcept
 Returns the number of child components that this component contains.
 
ComponentgetChildComponent (int index) const noexcept
 Returns one of this component's child components, by it index.
 
int getIndexOfChildComponent (const Component *child) const noexcept
 Returns the index of this component in the list of child components.
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 Looks for a child component with the specified ID.
 
void addChildComponent (Component *child, int zOrder=-1)
 Adds a child component to this one.
 
void addChildComponent (Component &child, int zOrder=-1)
 Adds a child component to this one.
 
void addAndMakeVisible (Component *child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addAndMakeVisible (Component &child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addChildAndSetID (Component *child, const String &componentID)
 Adds a child component to this one, makes it visible, and sets its component ID.
 
void removeChildComponent (Component *childToRemove)
 Removes one of this component's child-components.
 
ComponentremoveChildComponent (int childIndexToRemove)
 Removes one of this component's child-components by index.
 
void removeAllChildren ()
 Removes all this component's children.
 
void deleteAllChildren ()
 Removes all this component's children, and deletes them.
 
ComponentgetParentComponent () const noexcept
 Returns the component which this component is inside.
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 Searches the parent components for a component of a specified class.
 
ComponentgetTopLevelComponent () const noexcept
 Returns the highest-level component which contains this one or its parents.
 
bool isParentOf (const Component *possibleChild) const noexcept
 Checks whether a component is anywhere inside this component or its children.
 
virtual void parentHierarchyChanged ()
 Called to indicate that the component's parents have changed.
 
virtual void childrenChanged ()
 Subclasses can use this callback to be told when children are added or removed, or when their z-order changes.
 
virtual bool hitTest (int x, int y)
 Tests whether a given point inside the component.
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 Changes the default return value for the hitTest() method.
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 Retrieves the current state of the mouse-click interception flags.
 
bool contains (Point< int > localPoint)
 Returns true if a given point lies within this component or one of its children.
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 Returns true if a given point lies in this component, taking any overlapping siblings into account.
 
ComponentgetComponentAt (int x, int y)
 Returns the component at a certain point within this one.
 
ComponentgetComponentAt (Point< int > position)
 Returns the component at a certain point within this one.
 
void repaint ()
 Marks the whole component as needing to be redrawn.
 
void repaint (int x, int y, int width, int height)
 Marks a subsection of this component as needing to be redrawn.
 
void repaint (const Rectangle< int > &area)
 Marks a subsection of this component as needing to be redrawn.
 
void setBufferedToImage (bool shouldBeBuffered)
 Makes the component use an internal buffer to optimise its redrawing.
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 Generates a snapshot of part of this component.
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 Draws this component and all its subcomponents onto the specified graphics context.
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 This allows you to indicate that this component doesn't require its graphics context to be clipped when it is being painted.
 
void setComponentEffect (ImageEffectFilter *newEffect)
 Adds an effect filter to alter the component's appearance.
 
ImageEffectFiltergetComponentEffect () const noexcept
 Returns the current component effect.
 
LookAndFeelgetLookAndFeel () const noexcept
 Finds the appropriate look-and-feel to use for this component.
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 Sets the look and feel to use for this component.
 
virtual void lookAndFeelChanged ()
 Called to let the component react to a change in the look-and-feel setting.
 
void sendLookAndFeelChange ()
 Calls the lookAndFeelChanged() method in this component and all its children.
 
void setOpaque (bool shouldBeOpaque)
 Indicates whether any parts of the component might be transparent.
 
bool isOpaque () const noexcept
 Returns true if no parts of this component are transparent.
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 Indicates whether the component should be brought to the front when clicked.
 
bool isBroughtToFrontOnMouseClick () const noexcept
 Indicates whether the component should be brought to the front when clicked-on.
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component needs keyboard focus or not.
 
bool getWantsKeyboardFocus () const noexcept
 Returns true if the component is interested in getting keyboard focus.
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 Chooses whether a click on this component automatically grabs the focus.
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 Returns the last value set with setMouseClickGrabsKeyboardFocus().
 
void grabKeyboardFocus ()
 Tries to give keyboard focus to this component.
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 Returns true if this component currently has the keyboard focus.
 
void moveKeyboardFocusToSibling (bool moveToNext)
 Tries to move the keyboard focus to one of this component's siblings.
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component.
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified.
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the index used in determining the order in which focusable components should be traversed.
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 Indicates whether this component is a parent for components that can have their focus traversed.
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container.
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled.
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component.
 
virtual void enablementChanged ()
 Callback to indicate that this component has been enabled or disabled.
 
void setAlpha (float newAlpha)
 Changes the transparency of this component.
 
float getAlpha () const
 Returns the component's current transparancy level.
 
void setMouseCursor (const MouseCursor &cursorType)
 Changes the mouse cursor shape to use when the mouse is over this component.
 
void updateMouseCursor () const
 Forces the current mouse cursor to be updated.
 
virtual void paintOverChildren (Graphics &g)
 Components can override this method to draw over the top of their children.
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 Called when a mouse button has been double-clicked on a component.
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 Called when the mouse-wheel is moved.
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 Called when a pinch-to-zoom mouse-gesture is used.
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 Causes automatic repaints when the mouse enters or exits this component.
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 Registers a listener to be told when mouse events occur in this component.
 
void removeMouseListener (MouseListener *listenerToRemove)
 Deregisters a mouse listener.
 
void addKeyListener (KeyListener *newListener)
 Adds a listener that wants to hear about keypresses that this component receives.
 
void removeKeyListener (KeyListener *listenerToRemove)
 Removes a previously-registered key listener.
 
virtual bool keyPressed (const KeyPress &key)
 Called when a key is pressed.
 
virtual bool keyStateChanged (bool isKeyDown)
 Called when a key is pressed or released.
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 Called when a modifier key is pressed or released.
 
virtual void focusGained (FocusChangeType cause)
 Called to indicate that this component has just acquired the keyboard focus.
 
virtual void focusLost (FocusChangeType cause)
 Called to indicate that this component has just lost the keyboard focus.
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 Called to indicate that one of this component's children has been focused or unfocused.
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component.
 
bool isMouseButtonDown () const
 Returns true if the mouse button is currently held down in this component.
 
bool isMouseOverOrDragging () const
 True if the mouse is over this component, or if it's being dragged in this component.
 
Point< int > getMouseXYRelative () const
 Returns the mouse's current position, relative to this component.
 
virtual void moved ()
 Called when this component's position has been changed.
 
virtual void childBoundsChanged (Component *child)
 Called when one of this component's children is moved or resized.
 
virtual void parentSizeChanged ()
 Called when this component's immediate parent has been resized.
 
virtual void broughtToFront ()
 Called when this component has been moved to the front of its siblings.
 
void addComponentListener (ComponentListener *newListener)
 Adds a listener to be told about changes to the component hierarchy or position.
 
void removeComponentListener (ComponentListener *listenerToRemove)
 Removes a component listener.
 
void postCommandMessage (int commandId)
 Dispatches a numbered message to this component.
 
virtual void handleCommandMessage (int commandId)
 Called to handle a command that was sent by postCommandMessage().
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Runs a component modally, waiting until the loop terminates.
 
void exitModalState (int returnValue)
 Ends a component's modal state.
 
bool isCurrentlyModal () const noexcept
 Returns true if this component is the modal one.
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 Checks whether there's a modal component somewhere that's stopping this one from receiving messages.
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 When a component is modal, this callback allows it to choose which other components can still receive events.
 
virtual void inputAttemptWhenModal ()
 Called when the user tries to click on a component that is blocked by another modal component.
 
NamedValueSetgetProperties () noexcept
 Returns the set of properties that belong to this component.
 
const NamedValueSetgetProperties () const noexcept
 Returns the set of properties that belong to this component.
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 Looks for a colour that has been registered with the given colour ID number.
 
void setColour (int colourId, Colour newColour)
 Registers a colour to be used for a particular purpose.
 
void removeColour (int colourId)
 If a colour has been set with setColour(), this will remove it.
 
bool isColourSpecified (int colourId) const
 Returns true if the specified colour ID has been explicitly set for this component using the setColour() method.
 
void copyAllExplicitColoursTo (Component &target) const
 This looks for any colours that have been specified for this component, and copies them to the specified target component.
 
virtual void colourChanged ()
 This method is called when a colour is changed by the setColour() method.
 
virtual MarkerListgetMarkers (bool xAxis)
 Components can implement this method to provide a MarkerList.
 
void * getWindowHandle () const
 Returns the underlying native window handle for this component.
 
PositionergetPositioner () const noexcept
 Returns the Positioner object that has been set for this component.
 
void setPositioner (Positioner *newPositioner)
 Sets a new Positioner object for this component.
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 Gives the component a CachedComponentImage that should be used to buffer its painting.
 
CachedComponentImagegetCachedComponentImage () const noexcept
 Returns the object that was set by setCachedComponentImage().
 
 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 ()
 Destructor.
 

Additional Inherited Members

- Static Public Member Functions inherited from Component
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
 Returns the component that currently has the keyboard focus.
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 If any component has keyboard focus, this will defocus it.
 
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks)
 Ensures that a non-stop stream of mouse-drag events will be sent during the current mouse-drag operation.
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 Returns true if a mouse button is currently down.
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 Returns the number of components that are currently in a modal state.
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 Returns one of the components that are currently modal.
 
- Private Member Functions inherited from AsyncUpdater
 AsyncUpdater ()
 Creates an AsyncUpdater object.
 
virtual ~AsyncUpdater ()
 Destructor.
 
void triggerAsyncUpdate ()
 Causes the callback to be triggered at a later time.
 
void cancelPendingUpdate () noexcept
 This will stop any pending updates from happening.
 
void handleUpdateNowIfNeeded ()
 If an update has been triggered and is pending, this will invoke it synchronously.
 
bool isUpdatePending () const noexcept
 Returns true if there's an update callback in the pipeline.
 

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

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 ( )

Creates an empty table header.

TableHeaderComponent::~TableHeaderComponent ( )

Destructor.

Member Function Documentation

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
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.

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.

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
String TableHeaderComponent::getColumnName ( int  columnId) const

Returns the name for a column.

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

Changes the name of a column.

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.
int TableHeaderComponent::getColumnWidth ( int  columnId) const

Returns the width of one of the columns.

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.

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
bool TableHeaderComponent::isColumnVisible ( int  columnId) const

Returns true if this column is currently visible.

See Also
setColumnVisible
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
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
bool TableHeaderComponent::isSortedForwards ( ) const

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

See Also
setSortColumnId
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).

int TableHeaderComponent::getTotalWidth ( ) const

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

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.

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.

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.

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.

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.

bool TableHeaderComponent::isStretchToFitActive ( ) const

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

See Also
setStretchToFitActive
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.

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
bool TableHeaderComponent::isPopupMenuActive ( ) const

Returns true if the pop-up menu is enabled.

See Also
setPopupMenuActive
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
void TableHeaderComponent::restoreFromString ( const String storedVersion)

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

See Also
toString
void TableHeaderComponent::addListener ( Listener newListener)

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

void TableHeaderComponent::removeListener ( Listener listenerToRemove)

Removes a previously-registered listener.

virtual 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.

virtual 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
virtual 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
void TableHeaderComponent::paint ( Graphics )
overridevirtual

Reimplemented from Component.

void TableHeaderComponent::resized ( )
overridevirtual

Reimplemented from Component.

void TableHeaderComponent::mouseMove ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void TableHeaderComponent::mouseEnter ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void TableHeaderComponent::mouseExit ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void TableHeaderComponent::mouseDown ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void TableHeaderComponent::mouseDrag ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void TableHeaderComponent::mouseUp ( const MouseEvent )
overridevirtual

Reimplemented from Component.

MouseCursor TableHeaderComponent::getMouseCursor ( )
overridevirtual

Reimplemented from Component.

virtual void TableHeaderComponent::showColumnChooserMenu ( int  columnIdClicked)
virtual

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


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