org.apache.wicket.extensions.markup.html.tree

Class BaseTree

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

org.apache.wicket.extensions.markup.html.tree.AbstractTree

org.apache.wicket.extensions.markup.html.tree.BaseTree

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, EventListener, TreeModelListener, org.apache.wicket.ajax.AjaxRequestTarget.ITargetRespondListener, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, ITreeStateListener, org.apache.wicket.IConverterLocator, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

LabelTree

Deprecated.

@Deprecated
public abstract class BaseTree
extends AbstractTree

An abstract Tree component that should serve as a base for custom Tree Components. It has one abstract method - newNodeComponent(String, IModel) that needs to be overridden.

Author:

Matej Knopp

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BaseTree.ILinkCallback Deprecated. Helper class for calling an action from a link.

Field Summary

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

PANEL

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
BaseTree(String id) Deprecated. Construct.
BaseTree(String id, org.apache.wicket.model.IModel<? extends TreeModel> model) Deprecated. Construct.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.wicket.request.resource.ResourceReference	getCSS() Deprecated. Returns the stylesheet reference
protected String	getItemClass(Object node) Deprecated.
LinkType	getLinkType() Deprecated. Returns the current type of links on tree items.
protected String	getSelectedClass() Deprecated. Returns the class name that will be added to row's CSS class for selected rows
protected boolean	isForceRebuildOnSelectionChange() Deprecated. Determines whether the TreeNode needs to be rebuilt if it is selected or deselected
protected org.apache.wicket.Component	newJunctionLink(org.apache.wicket.MarkupContainer parent, String id, Object node) Deprecated. Creates the junction link for given node.
org.apache.wicket.MarkupContainer	newLink(String id, BaseTree.ILinkCallback callback) Deprecated. Creates a link of type specified by current linkType.
protected abstract org.apache.wicket.Component	newNodeComponent(String id, org.apache.wicket.model.IModel<Object> model) Deprecated. Creates a new component for the given TreeNode.
protected void	onJunctionLinkClicked(org.apache.wicket.ajax.AjaxRequestTarget target, Object node) Deprecated. Callback function called after user clicked on an junction link.
protected void	populateTreeItem(org.apache.wicket.markup.html.WebMarkupContainer item, int level) Deprecated. This method is called after creating every TreeItem.
void	renderHead(org.apache.wicket.markup.head.IHeaderResponse response) Deprecated.
void	setLinkType(LinkType linkType) Deprecated. Sets the type of links on tree items.

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

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

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

getRegionMarkup, newMarkupSourcingStrategy

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

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Constructor Detail

BaseTree

public BaseTree(String id)

Deprecated.

Construct.

Parameters:

id -

BaseTree

public BaseTree(String id,
        org.apache.wicket.model.IModel<? extends TreeModel> model)

Deprecated.

Construct.

Parameters:

id -

model -

Method Detail

getCSS

protected org.apache.wicket.request.resource.ResourceReference getCSS()

Deprecated.

Returns the stylesheet reference

Returns:

stylesheet reference

populateTreeItem

protected void populateTreeItem(org.apache.wicket.markup.html.WebMarkupContainer item,
                    int level)

Deprecated.

Description copied from class: AbstractTree

This method is called after creating every TreeItem. This is the place for adding components on item (junction links, labels, icons...)

Specified by:

populateTreeItem in class AbstractTree

Parameters:

item - newly created tree item. The node can be obtained as item.getModelObject()

level - how deep the component is in tree hierarchy (0 for root item)

See Also:

AbstractTree.populateTreeItem(WebMarkupContainer, int)

getItemClass

protected String getItemClass(Object node)

Deprecated.

getSelectedClass

protected String getSelectedClass()

Deprecated.

Returns the class name that will be added to row's CSS class for selected rows

Returns:

CSS class name

newNodeComponent

protected abstract org.apache.wicket.Component newNodeComponent(String id,
                                           org.apache.wicket.model.IModel<Object> model)

Deprecated.

Creates a new component for the given TreeNode.

Parameters:

id - component ID

model - model that returns the node

Returns:

component for node

newJunctionLink

protected org.apache.wicket.Component newJunctionLink(org.apache.wicket.MarkupContainer parent,
                                          String id,
                                          Object node)

Deprecated.

Creates the junction link for given node. Also (optionally) creates the junction image. If the node is a leaf (it has no children), the created junction link is non-functional.

Parameters:

parent - parent component of the link

id - wicket:id of the component

node - tree node for which the link should be created.

Returns:

The link component

onJunctionLinkClicked

protected void onJunctionLinkClicked(org.apache.wicket.ajax.AjaxRequestTarget target,
                         Object node)

Deprecated.

Callback function called after user clicked on an junction link. The node has already been expanded/collapsed (depending on previous status).

Parameters:

target - Request target - may be null on non-ajax call

node - Node for which this callback is relevant

newLink

public org.apache.wicket.MarkupContainer newLink(String id,
                                        BaseTree.ILinkCallback callback)

Deprecated.

Creates a link of type specified by current linkType. When the links is clicked it calls the specified callback.

Parameters:

id - The component id

callback - The link call back. null is passed for its onClick(AjaxRequestTarget) for LinkType.REGULAR and eventually for LinkType.AJAX_FALLBACK.

Returns:

The link component

getLinkType

public LinkType getLinkType()

Deprecated.

Returns the current type of links on tree items.

Returns:

The link type

setLinkType

public void setLinkType(LinkType linkType)

Deprecated.

Sets the type of links on tree items. After the link type is changed, the whole tree must be rebuilt (call invalidateAll).

Parameters:

linkType - type of links

isForceRebuildOnSelectionChange

protected boolean isForceRebuildOnSelectionChange()

Deprecated.

Description copied from class: AbstractTree

Determines whether the TreeNode needs to be rebuilt if it is selected or deselected

Overrides:

isForceRebuildOnSelectionChange in class AbstractTree

Returns:

true if the node should be rebuilt after (de)selection, false otherwise

See Also:

AbstractTree.isForceRebuildOnSelectionChange()

renderHead

public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)

Deprecated.

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class AbstractTree