Wt examples  4.0.3
Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
TreeNode Class Reference

Example implementation of a single tree list node. More...

#include <TreeNode.h>

Inheritance diagram for TreeNode:
Inheritance graph
[legend]

Public Member Functions

 TreeNode (const std::string labelText, TextFormat labelFormat, std::unique_ptr< IconPair > labelIcon)
 Construct a tree node with the given label. More...
 
void addChildNode (std::unique_ptr< TreeNode > node)
 Adds a child node. More...
 
void removeChildNode (TreeNode *node, int index)
 Removes a child node. More...
 
const std::vector< TreeNode * > & childNodes () const
 Returns the list of children. More...
 
void collapse ()
 Collapses this node. More...
 
void expand ()
 Expands this node. More...
 

Private Types

enum  ImageIndex { Middle = 0, Last = 1 }
 Two sets of images, for a normal node, and for the last node. More...
 

Private Member Functions

void adjustExpandIcon ()
 Adjust the expand icon. More...
 
bool isLastChildNode () const
 Returns if is the last child within its parent (is rendered differently) More...
 
void childNodesChanged ()
 Rerender when children have changed. More...
 
void undoCollapse ()
 Undo function for prelearning collapse() More...
 
void undoExpand ()
 Undo function for prelearning expand() More...
 

Private Attributes

std::vector< TreeNode * > childNodes_
 List of child nodes. More...
 
TreeNodeparentNode_
 The parent node. More...
 
WTable * layout_
 Layout (2x2 table). More...
 
IconPairexpandIcon_
 The icon for expanding or collapsing. More...
 
WImage * noExpandIcon_
 The single image shown instead of the expand/collapse icon when no children. More...
 
IconPairlabelIcon_
 The icon next to the label. More...
 
std::unique_ptr< WText > labelText_
 The label. More...
 
WText * childCountLabel_
 The children count '(x)' for x children. More...
 
WContainerWidget * expandedContent_
 The container in which the children are managed. More...
 
bool wasCollapsed_
 Was collapsed (for undo of prelearned collapse() and expand() slots. More...
 

Static Private Attributes

static std::string imageLine_ []
 
static std::string imagePlus_ []
 
static std::string imageMin_ []
 

Detailed Description

Example implementation of a single tree list node.

This is an example of a basic treelist implementation. As of version 1.1.8, a more flexible treenode implementation is included as part of the library: WTreeNode.

A tree list is constructed by nesting TreeNode objects in a tree hierarchy.

A TreeNode has a label, and optionally a two-state label icon, which defines a different image depending on the state of the node (expanded or collapsed). When the node has any children, a child count is also indicated.

Next to the icons, two style classes determine the look of a TreeNode: the label has style "treenodelabel", and the child count has as style "treenodechildcount".

Use CSS nested selectors to apply different styles to different treenodes. For example, to style the treenode with style class "mynode":

The behaviour of the tree node is to collapse all children when the node is expanded (this is similar to how most tree node implementations work).

The widget uses a number of images which must be available in an "icons/" folder (see the Wt treelist examples).

This widget is part of the Wt treelist example.

Definition at line 57 of file TreeNode.h.

Member Enumeration Documentation

◆ ImageIndex

enum TreeNode::ImageIndex
private

Two sets of images, for a normal node, and for the last node.

Enumerator
Middle 
Last 

Definition at line 141 of file TreeNode.h.

141 { Middle = 0, Last = 1 };

Constructor & Destructor Documentation

◆ TreeNode()

TreeNode::TreeNode ( const std::string  labelText,
TextFormat  labelFormat,
std::unique_ptr< IconPair labelIcon 
)

Construct a tree node with the given label.

The label is formatted in a WText with the given formatting. The labelIcon (if not 0) will appear next to the label and its state will reflect the expand/collapse state of the node.

Optionally, a userContent widget may be associated with the node. When expanded, this widget will be shown below the widget, but above any of the children nodes.

Definition at line 26 of file TreeNode.C.

29  : WCompositeWidget(),
30  parentNode_(nullptr),
31  labelIcon_(labelIcon.get())
32 {
33  // pre-learned stateless implementations ...
34  implementStateless(&TreeNode::expand, &TreeNode::undoExpand);
35  implementStateless(&TreeNode::collapse, &TreeNode::undoCollapse);
36 
37  // ... or auto-learned stateless implementations
38  // which do not need undo functions
39  //implementStateless(&TreeNode::expand);
40  //implementStateless(&TreeNode::collapse);
41 
42  auto layout = cpp14::make_unique<WTable>();
43  layout_ = layout.get();
44  setImplementation(std::move(layout));
45 
46  auto expandIcon =
47  cpp14::make_unique<IconPair>(imagePlus_[Last], imageMin_[Last]);
48  expandIcon_ = expandIcon.get();
49  expandIcon_->hide();
50 
51  auto noExpandIcon =
52  cpp14::make_unique<WImage>(imageLine_[Last]);
53 
54  noExpandIcon_ = noExpandIcon.get();
55 
56  auto expandedContent = cpp14::make_unique<WContainerWidget>();
57  expandedContent_ = expandedContent.get();
58  expandedContent_->hide();
59 
60  labelText_ = cpp14::make_unique<WText>(labelText);
61  labelText_->setTextFormat(labelFormat);
62  labelText_->setStyleClass("treenodelabel");
63 
64  auto childCountLabel = cpp14::make_unique<WText>();
65  childCountLabel_ = childCountLabel.get();
66  childCountLabel_->setMargin(7, Side::Left);
67  childCountLabel_->setStyleClass("treenodechildcount");
68 
69  layout_->elementAt(0, 0)->addWidget(std::move(expandIcon));
70  layout_->elementAt(0, 0)->addWidget(std::move(noExpandIcon));
71 
72  if (labelIcon) {
73  layout_->elementAt(0, 1)->addWidget(std::move(labelIcon));
74  labelIcon_->setVerticalAlignment(AlignmentFlag::Middle);
75  }
76  layout_->elementAt(0, 1)->addWidget(std::move(labelText_));
77  layout_->elementAt(0, 1)->addWidget(std::move(childCountLabel));
78 
79  layout_->elementAt(1, 1)->addWidget(std::move(expandedContent));
80 
81  layout_->elementAt(0, 0)->setContentAlignment(AlignmentFlag::Top);
82  layout_->elementAt(0, 1)->setContentAlignment(AlignmentFlag::Middle);
83 
84  expandIcon_->icon1Clicked->connect(this, &TreeNode::expand);
86 } //
WContainerWidget * expandedContent_
The container in which the children are managed.
Definition: TreeNode.h:120
void undoExpand()
Undo function for prelearning expand()
Definition: TreeNode.C:171
void undoCollapse()
Undo function for prelearning collapse()
Definition: TreeNode.C:160
void expand()
Expands this node.
Definition: TreeNode.C:144
EventSignal< WMouseEvent > * icon2Clicked
Signal emitted when clicked while in state 1 (icon 2 is shown).
Definition: IconPair.h:95
TreeNode * parentNode_
The parent node.
Definition: TreeNode.h:99
WText * childCountLabel_
The children count &#39;(x)&#39; for x children.
Definition: TreeNode.h:117
EventSignal< WMouseEvent > * icon1Clicked
Signal emitted when clicked while in state 0 (icon 1 is shown).
Definition: IconPair.h:90
static std::string imageMin_[]
Definition: TreeNode.h:145
IconPair * labelIcon_
The icon next to the label.
Definition: TreeNode.h:111
IconPair * expandIcon_
The icon for expanding or collapsing.
Definition: TreeNode.h:105
static std::string imageLine_[]
Definition: TreeNode.h:143
static std::string imagePlus_[]
Definition: TreeNode.h:144
WTable * layout_
Layout (2x2 table).
Definition: TreeNode.h:102
WImage * noExpandIcon_
The single image shown instead of the expand/collapse icon when no children.
Definition: TreeNode.h:108
std::unique_ptr< WText > labelText_
The label.
Definition: TreeNode.h:114
void collapse()
Collapses this node.
Definition: TreeNode.C:134

Member Function Documentation

◆ addChildNode()

void TreeNode::addChildNode ( std::unique_ptr< TreeNode node)

Adds a child node.

Definition at line 96 of file TreeNode.C.

97 {
98  childNodes_.push_back(node.get());
99  node->parentNode_ = this;
100 
101  expandedContent_->addWidget(std::move(node));
102 
104 }
WContainerWidget * expandedContent_
The container in which the children are managed.
Definition: TreeNode.h:120
std::vector< TreeNode * > childNodes_
List of child nodes.
Definition: TreeNode.h:96
void childNodesChanged()
Rerender when children have changed.
Definition: TreeNode.C:117

◆ adjustExpandIcon()

void TreeNode::adjustExpandIcon ( )
private

Adjust the expand icon.

Definition at line 188 of file TreeNode.C.

189 {
190  ImageIndex index = isLastChildNode() ? Last : Middle;
191 
192  if (expandIcon_->icon1()->imageLink().url() != imagePlus_[index])
193  expandIcon_->icon1()->setImageLink(imagePlus_[index]);
194  if (expandIcon_->icon2()->imageLink().url() != imageMin_[index])
195  expandIcon_->icon2()->setImageLink(imageMin_[index]);
196  if (noExpandIcon_->imageLink().url() != imageLine_[index])
197  noExpandIcon_->setImageLink(imageLine_[index]);
198 
199  if (index == Last) {
200  layout_->elementAt(0, 0)
201  ->decorationStyle().setBackgroundImage("");
202  layout_->elementAt(1, 0)
203  ->decorationStyle().setBackgroundImage("");
204  } else {
205  layout_->elementAt(0, 0)
206  ->decorationStyle().setBackgroundImage("icons/line-trunk.gif",
207  Orientation::Vertical);
208  layout_->elementAt(1, 0)
209  ->decorationStyle().setBackgroundImage("icons/line-trunk.gif",
210  Orientation::Vertical);
211  } //
212 
213  if (childNodes_.empty()) {
214  if (noExpandIcon_->isHidden()) {
215  noExpandIcon_->show();
216  expandIcon_->hide();
217  }
218  } else {
219  if (expandIcon_->isHidden()) {
220  noExpandIcon_->hide();
221  expandIcon_->show();
222  }
223  }
224 } //
WImage * icon2() const
Get the second icon image.
Definition: IconPair.h:67
ImageIndex
Two sets of images, for a normal node, and for the last node.
Definition: TreeNode.h:141
std::vector< TreeNode * > childNodes_
List of child nodes.
Definition: TreeNode.h:96
static std::string imageMin_[]
Definition: TreeNode.h:145
bool isLastChildNode() const
Returns if is the last child within its parent (is rendered differently)
Definition: TreeNode.C:88
IconPair * expandIcon_
The icon for expanding or collapsing.
Definition: TreeNode.h:105
static std::string imageLine_[]
Definition: TreeNode.h:143
static std::string imagePlus_[]
Definition: TreeNode.h:144
WTable * layout_
Layout (2x2 table).
Definition: TreeNode.h:102
WImage * noExpandIcon_
The single image shown instead of the expand/collapse icon when no children.
Definition: TreeNode.h:108
WImage * icon1() const
Get the first icon image.
Definition: IconPair.h:63

◆ childNodes()

const std::vector<TreeNode *>& TreeNode::childNodes ( ) const
inline

Returns the list of children.

Definition at line 84 of file TreeNode.h.

84 { return childNodes_; }
std::vector< TreeNode * > childNodes_
List of child nodes.
Definition: TreeNode.h:96

◆ childNodesChanged()

void TreeNode::childNodesChanged ( )
private

Rerender when children have changed.

Definition at line 117 of file TreeNode.C.

118 {
119  for (auto node : childNodes_)
120  node->adjustExpandIcon();
121 
123 
124  if (childNodes_.size())
126  ->setText("(" + std::to_string(childNodes_.size())
127  + ")");
128  else
129  childCountLabel_->setText("");
130 
131  resetLearnedSlots();
132 } //
WText * childCountLabel_
The children count &#39;(x)&#39; for x children.
Definition: TreeNode.h:117
std::vector< TreeNode * > childNodes_
List of child nodes.
Definition: TreeNode.h:96
void adjustExpandIcon()
Adjust the expand icon.
Definition: TreeNode.C:188

◆ collapse()

void TreeNode::collapse ( )

Collapses this node.

Definition at line 134 of file TreeNode.C.

135 {
136  wasCollapsed_ = expandedContent_->isHidden();
137 
138  expandIcon_->setState(0);
139  expandedContent_->hide();
140  if (labelIcon_)
141  labelIcon_->setState(0);
142 } //
WContainerWidget * expandedContent_
The container in which the children are managed.
Definition: TreeNode.h:120
void setState(int num)
Set which icon should be visible.
Definition: IconPair.C:50
IconPair * labelIcon_
The icon next to the label.
Definition: TreeNode.h:111
bool wasCollapsed_
Was collapsed (for undo of prelearned collapse() and expand() slots.
Definition: TreeNode.h:132
IconPair * expandIcon_
The icon for expanding or collapsing.
Definition: TreeNode.h:105

◆ expand()

void TreeNode::expand ( )

Expands this node.

Definition at line 144 of file TreeNode.C.

145 {
146  wasCollapsed_ = expandedContent_->isHidden();
147 
148  expandIcon_->setState(1);
149  expandedContent_->show();
150  if (labelIcon_)
151  labelIcon_->setState(1);
152 
153  /*
154  * collapse all children
155  */
156  for (auto node : childNodes_)
157  node->collapse();
158 } //
WContainerWidget * expandedContent_
The container in which the children are managed.
Definition: TreeNode.h:120
void setState(int num)
Set which icon should be visible.
Definition: IconPair.C:50
std::vector< TreeNode * > childNodes_
List of child nodes.
Definition: TreeNode.h:96
IconPair * labelIcon_
The icon next to the label.
Definition: TreeNode.h:111
bool wasCollapsed_
Was collapsed (for undo of prelearned collapse() and expand() slots.
Definition: TreeNode.h:132
IconPair * expandIcon_
The icon for expanding or collapsing.
Definition: TreeNode.h:105

◆ isLastChildNode()

bool TreeNode::isLastChildNode ( ) const
private

Returns if is the last child within its parent (is rendered differently)

Definition at line 88 of file TreeNode.C.

89 {
90  if (parentNode_) {
91  return parentNode_->childNodes_.back() == this;
92  } else
93  return true;
94 }
TreeNode * parentNode_
The parent node.
Definition: TreeNode.h:99
std::vector< TreeNode * > childNodes_
List of child nodes.
Definition: TreeNode.h:96

◆ removeChildNode()

void TreeNode::removeChildNode ( TreeNode node,
int  index 
)

Removes a child node.

Definition at line 106 of file TreeNode.C.

107 {
108  childNodes_.erase(childNodes_.begin() + index);
109 
110  node->parentNode_ = nullptr;
111 
112  expandedContent_->removeWidget(node);
113 
115 } //
WContainerWidget * expandedContent_
The container in which the children are managed.
Definition: TreeNode.h:120
TreeNode * parentNode_
The parent node.
Definition: TreeNode.h:99
std::vector< TreeNode * > childNodes_
List of child nodes.
Definition: TreeNode.h:96
void childNodesChanged()
Rerender when children have changed.
Definition: TreeNode.C:117

◆ undoCollapse()

void TreeNode::undoCollapse ( )
private

Undo function for prelearning collapse()

Definition at line 160 of file TreeNode.C.

161 {
162  if (!wasCollapsed_) {
163  // re-expand
164  expandIcon_->setState(1);
165  expandedContent_->show();
166  if (labelIcon_)
167  labelIcon_->setState(1);
168  }
169 }
WContainerWidget * expandedContent_
The container in which the children are managed.
Definition: TreeNode.h:120
void setState(int num)
Set which icon should be visible.
Definition: IconPair.C:50
IconPair * labelIcon_
The icon next to the label.
Definition: TreeNode.h:111
bool wasCollapsed_
Was collapsed (for undo of prelearned collapse() and expand() slots.
Definition: TreeNode.h:132
IconPair * expandIcon_
The icon for expanding or collapsing.
Definition: TreeNode.h:105

◆ undoExpand()

void TreeNode::undoExpand ( )
private

Undo function for prelearning expand()

Definition at line 171 of file TreeNode.C.

172 {
173  if (wasCollapsed_) {
174  // re-collapse
175  expandIcon_->setState(0);
176  expandedContent_->hide();
177  if (labelIcon_)
178  labelIcon_->setState(0);
179  }
180 
181  /*
182  * undo collapse of children
183  */
184  for (auto node : childNodes_)
185  node->undoCollapse();
186 } //
WContainerWidget * expandedContent_
The container in which the children are managed.
Definition: TreeNode.h:120
void setState(int num)
Set which icon should be visible.
Definition: IconPair.C:50
std::vector< TreeNode * > childNodes_
List of child nodes.
Definition: TreeNode.h:96
IconPair * labelIcon_
The icon next to the label.
Definition: TreeNode.h:111
bool wasCollapsed_
Was collapsed (for undo of prelearned collapse() and expand() slots.
Definition: TreeNode.h:132
IconPair * expandIcon_
The icon for expanding or collapsing.
Definition: TreeNode.h:105

Member Data Documentation

◆ childCountLabel_

WText* TreeNode::childCountLabel_
private

The children count '(x)' for x children.

Definition at line 117 of file TreeNode.h.

◆ childNodes_

std::vector<TreeNode *> TreeNode::childNodes_
private

List of child nodes.

Definition at line 96 of file TreeNode.h.

◆ expandedContent_

WContainerWidget* TreeNode::expandedContent_
private

The container in which the children are managed.

Definition at line 120 of file TreeNode.h.

◆ expandIcon_

IconPair* TreeNode::expandIcon_
private

The icon for expanding or collapsing.

Definition at line 105 of file TreeNode.h.

◆ imageLine_

std::string TreeNode::imageLine_
staticprivate
Initial value:
= { "icons/line-middle.gif",
"icons/line-last.gif" }

Definition at line 143 of file TreeNode.h.

◆ imageMin_

std::string TreeNode::imageMin_
staticprivate
Initial value:
= { "icons/nav-minus-line-middle.gif",
"icons/nav-minus-line-last.gif" }

Definition at line 145 of file TreeNode.h.

◆ imagePlus_

std::string TreeNode::imagePlus_
staticprivate
Initial value:
= { "icons/nav-plus-line-middle.gif",
"icons/nav-plus-line-last.gif" }

Definition at line 144 of file TreeNode.h.

◆ labelIcon_

IconPair* TreeNode::labelIcon_
private

The icon next to the label.

Definition at line 111 of file TreeNode.h.

◆ labelText_

std::unique_ptr<WText> TreeNode::labelText_
private

The label.

Definition at line 114 of file TreeNode.h.

◆ layout_

WTable* TreeNode::layout_
private

Layout (2x2 table).

Definition at line 102 of file TreeNode.h.

◆ noExpandIcon_

WImage* TreeNode::noExpandIcon_
private

The single image shown instead of the expand/collapse icon when no children.

Definition at line 108 of file TreeNode.h.

◆ parentNode_

TreeNode* TreeNode::parentNode_
private

The parent node.

Definition at line 99 of file TreeNode.h.

◆ wasCollapsed_

bool TreeNode::wasCollapsed_
private

Was collapsed (for undo of prelearned collapse() and expand() slots.

Definition at line 132 of file TreeNode.h.


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

Generated on Mon Jan 14 2019 for the C++ Web Toolkit (Wt) by doxygen 1.8.14