org.apache.wicket.extensions.markup.html.tree.table
Class TreeTable

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
                  org.apache.wicket.markup.html.panel.Panel
                      org.apache.wicket.markup.html.tree.AbstractTree
                          org.apache.wicket.extensions.markup.html.tree.DefaultAbstractTree
                              org.apache.wicket.extensions.markup.html.tree.table.TreeTable

All Implemented Interfaces:

Serializable, EventListener, TreeModelListener, AjaxRequestTarget.ITargetRespondListener, IClusterable, IConverterLocator, IHeaderPartContainerProvider, ITreeStateListener

public class TreeTable
extends DefaultAbstractTree

TreeTable is a component that represents a grid with a tree. It's divided into columns. One of the columns has to be column derived from AbstractTreeColumn.

Author:

Matej Knopp

See Also:

Serialized Form

Nested Class Summary

static interface

TreeTable.IRenderNodeCallback Callback for rendering tree node text.

Nested classes/interfaces inherited from class org.apache.wicket.extensions.markup.html.tree.DefaultAbstractTree

DefaultAbstractTree.ILinkCallback, DefaultAbstractTree.LinkType

Nested classes/interfaces inherited from class org.apache.wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor<T extends Component>, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

TreeTable(String id, IColumn[] columns)
Creates the TreeTable for the given array of columns.

TreeTable(String id, IModel model, IColumn[] columns)
Creates the TreeTable for the given model and array of columns.

TreeTable(String id, TreeModel model, IColumn[] columns)
Creates the TreeTable for the given TreeModel and array of columns.

Method Summary

protected void	addHeader() Adds the header to the TreeTable.
protected ResourceReference	getCSS() Returns the resource reference of default stylesheet.
static Component	newTreeCell(MarkupContainer parent, String id, TreeNode node, int level, TreeTable.IRenderNodeCallback callback, TreeTable table) Creates a tree cell for given node.
protected Component	newTreePanel(MarkupContainer parent, String id, TreeNode node, int level, TreeTable.IRenderNodeCallback renderNodeCallback) Creates a new instance of the TreeFragment.
protected void	onBeforeAttach() This method is called before the onAttach is called.
protected void	populateTreeItem(WebMarkupContainer item, int level) Populates one row of the tree.

Methods inherited from class org.apache.wicket.extensions.markup.html.tree.DefaultAbstractTree

getFolderClosed, getFolderOpen, getItem, getLinkType, getNodeIcon, newIndentation, newJunctionImage, newJunctionLink, newLink, newNodeIcon, newNodeLink, onJunctionLinkClicked, onNodeLinkClicked, setLinkType

Methods inherited from class org.apache.wicket.markup.html.tree.AbstractTree

addComponent, allNodesCollapsed, allNodesExpanded, getChildAt, getChildCount, getModel, getModelObject, getNodeComponent, getParentNode, getTreeState, invalidateAll, isForceRebuildOnSelectionChange, isLeaf, isNodeExpanded, isRootLess, markNodeChildrenDirty, markNodeDirty, newTreeState, nodeChildren, nodeCollapsed, nodeExpanded, nodeSelected, nodeUnselected, onAfterRender, onBeforeRender, onDetach, onTargetRespond, setModel, setModelObject, setRootLess, treeNodesChanged, treeNodesInserted, treeNodesRemoved, treeStructureChanged, updateTree, updateTree

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

onComponentTag, onComponentTagBody, renderHead

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup

newHeaderPartContainer, renderHeadFromAssociatedMarkupFile

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAttach, onBeginRequest, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TreeTable

public TreeTable(String id,
                 IColumn[] columns)

Creates the TreeTable for the given array of columns.

Parameters:

id -

columns -

TreeTable

public TreeTable(String id,
                 IModel model,
                 IColumn[] columns)

Creates the TreeTable for the given model and array of columns.

Parameters:

id - The component id

model - The tree model

columns - The columns

TreeTable

public TreeTable(String id,
                 TreeModel model,
                 IColumn[] columns)

Creates the TreeTable for the given TreeModel and array of columns.

Parameters:

id - The component id

model - The tree model

columns - The columns

Method Detail

newTreeCell

public static Component newTreeCell(MarkupContainer parent,
                                    String id,
                                    TreeNode node,
                                    int level,
                                    TreeTable.IRenderNodeCallback callback,
                                    TreeTable table)

Creates a tree cell for given node. This method is supposed to be used by TreeColumns (columns that draw the actual tree).

Parameters:

parent - Parent component

id - Component ID

node - Tree node for the row

level - How deep is the node nested (for convenience)

callback - Used to get the display string

table - Tree table

Returns:

The tree cell

addHeader

protected void addHeader()

Adds the header to the TreeTable.

getCSS

protected ResourceReference getCSS()

Description copied from class: DefaultAbstractTree

Returns the resource reference of default stylesheet.

Overrides:

getCSS in class DefaultAbstractTree

Returns:

The package resource reference

See Also:

org.apache.wicket.markup.html.tree.DefaultAbstractTree#getCSS()

newTreePanel

protected Component newTreePanel(MarkupContainer parent,
                                 String id,
                                 TreeNode node,
                                 int level,
                                 TreeTable.IRenderNodeCallback renderNodeCallback)

Creates a new instance of the TreeFragment.

Parameters:

parent - The parent component

id - The component id

node - The tree node

level - The level of the tree row

renderNodeCallback - The node call back

Returns:

The tree panel

onBeforeAttach

protected void onBeforeAttach()

Description copied from class: AbstractTree

This method is called before the onAttach is called. Code here gets executed before the items have been populated.

Overrides:

onBeforeAttach in class AbstractTree

See Also:

AbstractTree.onBeforeAttach()

populateTreeItem

protected void populateTreeItem(WebMarkupContainer item,
                                int level)

Populates one row of the tree.

Specified by:

populateTreeItem in class AbstractTree

Parameters:

item - the tree node component

level - the current level