Wt  3.3.9
Public Member Functions | Protected Member Functions | List of all members
Wt::WTreeTableNode Class Reference

A specialized tree node which allows additional data to be associated with each node. More...

#include <Wt/WTreeTableNode>

Inheritance diagram for Wt::WTreeTableNode:
Inheritance graph
[legend]

Public Member Functions

 WTreeTableNode (const WString &labelText, WIconPair *labelIcon=0, WTreeTableNode *parentNode=0)
 Creates a new tree table node. More...
 
void setColumnWidget (int column, WWidget *item)
 Sets a widget to be displayed in the given column for this node. More...
 
WWidgetcolumnWidget (int column)
 Returns the widget set for a column. More...
 
WTreeTabletable () const
 Returns the table for this node. More...
 
virtual void insertChildNode (int index, WTreeNode *node)
 Inserts a child node. More...
 
- Public Member Functions inherited from Wt::WTreeNode
 WTreeNode (const WString &labelText, WIconPair *labelIcon=0, WTreeNode *parentNode=0)
 Creates a tree node with the given label. More...
 
 ~WTreeNode ()
 Destructor.
 
virtual WTreetree () const
 Returns the tree. More...
 
WTextlabel () const
 Returns the label.
 
WIconPairlabelIcon () const
 Returns the label icon.
 
void setLabelIcon (WIconPair *labelIcon)
 Sets the label icon.
 
void addChildNode (WTreeNode *node)
 Adds a child node. More...
 
void removeChildNode (WTreeNode *node)
 Removes a child node. More...
 
const std::vector< WTreeNode * > & childNodes () const
 Returns the list of children.
 
virtual int displayedChildCount () const
 Returns the number of children that should be displayed. More...
 
void setChildCountPolicy (ChildCountPolicy policy)
 Configures how and when the child count should be displayed. More...
 
ChildCountPolicy childCountPolicy () const
 Returns the child count policy. More...
 
void setImagePack (const std::string &url)
 Sets the image pack for this (sub)tree (deprecated). More...
 
void setLoadPolicy (LoadPolicy loadPolicy)
 Sets the load policy for this tree. More...
 
bool isExpanded () const
 Returns whether this node is expanded.
 
void setSelectable (bool selectable)
 Allows this node to be selected. More...
 
virtual bool isSelectable () const
 Returns if this node may be selected. More...
 
WTreeNodeparentNode () const
 Returns the parent node. More...
 
void setNodeVisible (bool visible)
 Sets the visibility of the node itself. More...
 
void setChildrenDecorated (bool decorated)
 Sets whether this node's children are decorated. More...
 
void setInteractive (bool interactive)
 Sets whether this node is interactive. More...
 
void expand ()
 Expands this node. More...
 
void collapse ()
 Collapses this node. More...
 
EventSignal< WMouseEvent > & expanded ()
 Signal emitted when the node is expanded by the user. More...
 
EventSignal< WMouseEvent > & collapsed ()
 Signal emitted when the node is collapsed by the user. More...
 
Signal< bool > & selected ()
 Signal that is emitted when the node is added or removed from the selection More...
 
- Public Member Functions inherited from Wt::WCompositeWidget
 WCompositeWidget (WContainerWidget *parent=0)
 Creates a WCompositeWidget. More...
 
 WCompositeWidget (WWidget *implementation, WContainerWidget *parent)
 Creates a WCompositeWidget with given implementation. More...
 
virtual void setObjectName (const std::string &name)
 Sets an object name. More...
 
virtual std::string objectName () const
 Returns the object name. More...
 
virtual const std::string id () const
 Returns the (unique) identifier for this object. More...
 
virtual void setPositionScheme (PositionScheme scheme)
 Sets the CSS position scheme. More...
 
virtual PositionScheme positionScheme () const
 Returns the CSS position scheme. More...
 
virtual void setOffsets (const WLength &offset, WFlags< Side > sides=All)
 Sets CSS offsets for a non-statically positioned widget. More...
 
virtual WLength offset (Side s) const
 Returns a CSS offset. More...
 
virtual void resize (const WLength &width, const WLength &height)
 Resizes the widget. More...
 
virtual WLength width () const
 Returns the width. More...
 
virtual WLength height () const
 Returns the height. More...
 
virtual void setMinimumSize (const WLength &width, const WLength &height)
 Sets a minimum size. More...
 
virtual WLength minimumWidth () const
 Returns the minimum width. More...
 
virtual WLength minimumHeight () const
 Returns the minimum height. More...
 
virtual void setMaximumSize (const WLength &width, const WLength &height)
 Sets a maximum size. More...
 
virtual WLength maximumWidth () const
 Returns the maximum width. More...
 
virtual WLength maximumHeight () const
 Returns the maximum height. More...
 
virtual void setLineHeight (const WLength &height)
 Sets the CSS line height for contained text.
 
virtual WLength lineHeight () const
 Returns the CSS line height for contained text. More...
 
virtual void setFloatSide (Side s)
 Specifies a CSS float side. More...
 
virtual Side floatSide () const
 Returns the CSS float side. More...
 
virtual void setClearSides (WFlags< Side > sides)
 Sets the sides that should be cleared of floats. More...
 
virtual WFlags< SideclearSides () const
 Returns the sides that should remain empty. More...
 
virtual void setMargin (const WLength &margin, WFlags< Side > sides=All)
 Sets CSS margins around the widget. More...
 
virtual WLength margin (Side side) const
 Returns a CSS margin set. More...
 
virtual void setHiddenKeepsGeometry (bool enabled)
 Sets whether the widget keeps its geometry when hidden. More...
 
virtual bool hiddenKeepsGeometry () const
 Returns whether the widget keeps its geometry when hidden. More...
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation())
 Hides or shows the widget. More...
 
virtual bool isHidden () const
 Returns whether the widget is set hidden. More...
 
virtual bool isVisible () const
 Returns whether the widget is visible. More...
 
virtual void setDisabled (bool disabled)
 Sets whether the widget is disabled. More...
 
virtual bool isDisabled () const
 Returns whether the widget is set disabled. More...
 
virtual bool isEnabled () const
 Returns whether the widget is enabled. More...
 
virtual void setPopup (bool popup)
 Lets the widget overlay over other sibling widgets. More...
 
virtual bool isPopup () const
 Returns whether the widget is overlayed. More...
 
virtual void setInline (bool isInline)
 Sets whether the widget is displayed inline or as a block. More...
 
virtual bool isInline () const
 Returns whether the widget is displayed inline or as block. More...
 
virtual void setDecorationStyle (const WCssDecorationStyle &style)
 Sets a CSS decoration style. More...
 
virtual WCssDecorationStyledecorationStyle ()
 Returns the decoration style of this widget. More...
 
virtual void setStyleClass (const WString &styleClass)
 Sets (one or more) CSS style classes. More...
 
virtual WString styleClass () const
 Returns the CSS style class. More...
 
virtual void addStyleClass (const WString &styleClass, bool force=false)
 Adds a CSS style class. More...
 
virtual void removeStyleClass (const WString &styleClass, bool force=false)
 Removes a CSS style class. More...
 
virtual bool hasStyleClass (const WString &styleClass) const
 Returns whether the widget has a style class.
 
virtual void setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto)
 Sets the vertical alignment. More...
 
virtual AlignmentFlag verticalAlignment () const
 Returns the vertical alignment. More...
 
virtual WLength verticalAlignmentLength () const
 Returns the fixed vertical alignment that was set. More...
 
virtual void setToolTip (const WString &text, TextFormat textFormat=PlainText)
 Sets a tooltip. More...
 
virtual WString toolTip () const
 Returns the tooltip.
 
virtual void setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
 Enable deferred tooltip. More...
 
virtual void refresh ()
 Refresh the widget. More...
 
virtual void setAttributeValue (const std::string &name, const WString &value)
 Sets an attribute value. More...
 
virtual WString attributeValue (const std::string &name) const
 Returns an attribute value. More...
 
virtual void setJavaScriptMember (const std::string &name, const std::string &value)
 Sets a JavaScript member. More...
 
virtual std::string javaScriptMember (const std::string &name) const
 Returns the value of a JavaScript member. More...
 
virtual void callJavaScriptMember (const std::string &name, const std::string &args)
 Calls a JavaScript member. More...
 
virtual void load ()
 Loads content just before the widget is used. More...
 
virtual bool loaded () const
 Returns whether this widget has been loaded. More...
 
virtual void setCanReceiveFocus (bool enabled)
 Sets whether the widget can receive focus. More...
 
virtual bool canReceiveFocus () const
 Returns whether the widget can receive focus. More...
 
virtual void setFocus (bool focus)
 Sets focus. More...
 
virtual bool setFirstFocus ()
 Set focus on the widget's first descendant. More...
 
virtual bool hasFocus () const
 Returns whether the widget currently has the focus.
 
virtual void setTabIndex (int index)
 Sets the tab index. More...
 
virtual int tabIndex () const
 Returns the tab index. More...
 
virtual void setId (const std::string &id)
 Sets the CSS Id. More...
 
virtual WWidgetfind (const std::string &name)
 Finds a descendent widget by name. More...
 
virtual WWidgetfindById (const std::string &name)
 Finds a descendent widget by id.
 
virtual void doJavaScript (const std::string &js)
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual void propagateSetEnabled (bool enabled)
 Propagates that a widget was enabled or disabled through children. More...
 
virtual bool scrollVisibilityEnabled () const WT_CXX11ONLY(finaloverride)
 Returns whether scroll visibility detection is enabled for this widget. More...
 
virtual void setScrollVisibilityEnabled (bool enabled) WT_CXX11ONLY(finaloverride)
 Sets whether scroll visibility detection is enabled for this widget. More...
 
virtual int scrollVisibilityMargin () const WT_CXX11ONLY(finaloverride)
 Returns the margin around the viewport within which the widget is considered visible. More...
 
virtual void setScrollVisibilityMargin (int margin) WT_CXX11ONLY(finaloverride)
 Sets the margin around the viewport within which the widget is considered visible. More...
 
virtual Signal< bool > & scrollVisibilityChanged () WT_CXX11ONLY(finaloverride)
 Signal triggered when the scroll visibility of this widget changes. More...
 
virtual bool isScrollVisible () const WT_CXX11ONLY(finaloverride)
 Returns whether this widget is currently considered scroll visible. More...
 
virtual void setThemeStyleEnabled (bool enabled)
 Sets whether theme styling for a widget is enabled or disabled. More...
 
virtual bool isThemeStyleEnabled () const
 Returns whether this widget is currently styled by the chosen theme. More...
 
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 Destructor. More...
 
WWidgetparent () const
 Returns the parent widget. More...
 
virtual void removeChild (WObject *child)
 Removes a child object. More...
 
void setWidth (const WLength &width)
 Sets the width. More...
 
void setHeight (const WLength &height)
 Sets the height. More...
 
virtual void positionAt (const WWidget *widget, Orientation orientation=Vertical)
 Positions a widget next to another widget. More...
 
virtual void toggleStyleClass (const WString &styleClass, bool add, bool force=false)
 Toggles a CSS style class.
 
std::string jsRef () const
 Returns a JavaScript expression to the corresponding DOM node. More...
 
void setFocus ()
 Sets focus. More...
 
virtual void acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
 Sets a mime type to be accepted for dropping. More...
 
virtual void stopAcceptDrops (const std::string &mimeType)
 Indicates that a mime type is no longer accepted for dropping. More...
 
virtual void htmlText (std::ostream &out)
 Streams the (X)HTML representation. More...
 
bool isRendered () const
 Returns whether the widget is rendered. More...
 
void hide ()
 Hides the widget. More...
 
void animateHide (const WAnimation &animation)
 Hides the widget using an animation. More...
 
void show ()
 Shows the widget. More...
 
void animateShow (const WAnimation &animation)
 Shows the widget using an animation. More...
 
void enable ()
 Enables the widget. More...
 
void disable ()
 Disable thes widget. More...
 
bool layoutSizeAware () const
 Returns whether the widget is layout size aware. More...
 
- Public Member Functions inherited from Wt::WObject
 WObject (WObject *parent=0)
 Create a WObject with a given parent object. More...
 
virtual ~WObject ()
 Destructor. More...
 
void resetLearnedSlots ()
 Resets learned stateless slot implementations. More...
 
template<class T >
void resetLearnedSlot (void(T::*method)())
 Resets a learned stateless slot implementation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)())
 Declares a slot to be stateless and learn client-side behaviour on first invocation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)(), void(T::*undoMethod)())
 Declares a slot to be stateless and learn client-side behaviour in advance. More...
 
void isNotStateless ()
 Marks the current function as not stateless. More...
 
template<class T >
WStatelessSlot * implementJavaScript (void(T::*method)(), const std::string &jsCode)
 Provides a JavaScript implementation for a method. More...
 
void addChild (WObject *child)
 Adds a child object. More...
 
const std::vector< WObject * > & children () const
 Returns the children.
 
WObjectparent () const
 Returns the parent object.
 

Protected Member Functions

virtual void setTable (WTreeTable *table)
 Sets the table for this node. More...
 
- Protected Member Functions inherited from Wt::WTreeNode
 WTreeNode (WTreeNode *parentNode=0)
 Creates a tree node with empty labelArea(). More...
 
WContainerWidgetlabelArea ()
 Accesses the container widget that holds the label area. More...
 
virtual void populate ()
 Populates the node dynamically on loading. More...
 
bool populated () const
 Returns whether this node has already been populated. More...
 
virtual bool expandable ()
 Returns whether this node can be expanded. More...
 
virtual void renderSelected (bool selected)
 Renders the node to be selected. More...
 
std::string imagePack () const
 The image pack that is used for this tree node (deprecated). More...
 
virtual void descendantRemoved (WTreeNode *node)
 Reacts to the removal of a descendant node. More...
 
virtual void descendantAdded (WTreeNode *node)
 Reacts to the addition of a descendant node. More...
 
virtual void doExpand ()
 The actual expand. More...
 
virtual void doCollapse ()
 The actual collapse. More...
 
virtual void undoDoExpand ()
 Undo method for doCollapse() stateless implementation. More...
 
virtual void undoDoCollapse ()
 Undo method for doCollapse() stateless implementation. More...
 
WIconPairexpandIcon () const
 Accesses the icon pair that allows expansion of the tree node.
 
- Protected Member Functions inherited from Wt::WCompositeWidget
virtual void enableAjax ()
 Progresses to an Ajax-enabled widget. More...
 
void setImplementation (WWidget *widget)
 Set the implementation widget. More...
 
WWidgetimplementation ()
 Get the implementation widget. More...
 
virtual int boxPadding (Orientation orientation) const
 Returns the widget's built-in padding. More...
 
virtual int boxBorder (Orientation orientation) const
 Returns the widget's built-in border width. More...
 
virtual void render (WFlags< RenderFlag > flags)
 Renders the widget. More...
 
- Protected Member Functions inherited from Wt::WWidget
void setLayoutSizeAware (bool sizeAware)
 Sets the widget to be aware of its size set by a layout manager. More...
 
virtual void layoutSizeChanged (int width, int height)
 Virtual method that indicates a size change. More...
 
 WWidget (WContainerWidget *parent=0)
 Creates a widget. More...
 
virtual void dropEvent (WDropEvent dropEvent)
 Handles a drop event. More...
 
void scheduleRender (WFlags< RepaintFlag > flags=0)
 Schedules rerendering of the widget. More...
 
virtual WStatelessSlot * getStateless (Method method)
 On-demand stateless slot implementation. More...
 

Additional Inherited Members

- Public Types inherited from Wt::WTreeNode
- Public Types inherited from Wt::WObject
typedef void(WObject::* Method) ()
 Typedef for a WObject method without arguments.
 
- Static Public Member Functions inherited from Wt::WWidget
static WString tr (const char *key)
 Short hand for WString::tr() More...
 
- Static Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. More...
 

Detailed Description

A specialized tree node which allows additional data to be associated with each node.

Additional data for each column can be set using setColumnWidget().

See also
WTreeNode, WTreeTable

Constructor & Destructor Documentation

Wt::WTreeTableNode::WTreeTableNode ( const WString labelText,
WIconPair labelIcon = 0,
WTreeTableNode parentNode = 0 
)

Creates a new tree table node.

See also
WTreeNode::WTreeNode()

Member Function Documentation

WWidget * Wt::WTreeTableNode::columnWidget ( int  column)

Returns the widget set for a column.

Returns the widget set previously using setColumnWidget(), or 0 if no widget was previously set.

void Wt::WTreeTableNode::insertChildNode ( int  index,
WTreeNode node 
)
virtual

Inserts a child node.

Inserts the node node at index index.

Reimplemented from Wt::WTreeNode.

void Wt::WTreeTableNode::setColumnWidget ( int  column,
WWidget item 
)

Sets a widget to be displayed in the given column for this node.

Columns are counted starting from 0 for the tree list itself, and 1 for the first additional column.

The node label (in column 0) is not considered a column widget. To set a custom widget in column 0, you can add a widget to the labelArea().

void Wt::WTreeTableNode::setTable ( WTreeTable table)
protectedvirtual

Sets the table for this node.

This method is called when the node is inserted, directly, or indirectly into a table.

You may want to reimplement this method if you wish to customize the behaviour of the node depending on table properties. For example to only associate data with the node when the tree list is actually used inside a table.

See also
WTreeTableNode::table()
WTreeTable* Wt::WTreeTableNode::table ( ) const

Returns the table for this node.

See also
WTreeTableNode::setTable()

Generated on Tue Nov 21 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11