com.wewebu.ow.server.dmsdialogs.views
Class OwObjectTreeView

java.lang.Object
  com.wewebu.ow.server.ui.OwEventTarget
      com.wewebu.ow.server.ui.OwView
          com.wewebu.ow.server.ui.OwTreeView
              com.wewebu.ow.server.dmsdialogs.views.OwObjectTreeView

All Implemented Interfaces:

OwBaseView, OwUpdateTarget

Direct Known Subclasses:

OwObjectTreeViewEXTJS

public class OwObjectTreeView
extends OwTreeView

TreeView Module to display Tree Views of OwObjects.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Nested Class Summary

Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwTreeView

OwTreeView.OwTreeViewEventListner, OwTreeView.OwTreeViewNode

Field Summary

protected OwConfiguration	m_Configuration application m_Configuration reference
protected int	m_iMaxChildSize maximum number of child nodes

Fields inherited from class com.wewebu.ow.server.ui.OwTreeView

childrenSort, DISPLAY_MODE_REGISTER_NODES, DISPLAY_MODE_TREE_NODES, m_eventlistner, m_focusNode, m_nodeMap, m_root, m_selectedNode, m_strDesignURL, m_strPath, NODE_ID_KEY, PATH_DELIMITER

Fields inherited from class com.wewebu.ow.server.ui.OwView

CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget

Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView

EMPTY_STRING

Constructor Summary

OwObjectTreeView()

Method Summary

protected List	createChildObjects(Object obj_p) Create a list of child objects to the given object.
protected void	expandParents(Object theObject_p) Expand the parents of the current object
protected String	getCloseIconURL(Object obj_p, OwTreeView.OwTreeViewNode node_p) get a URL to the close icon to be implemented by the derived class
protected String	getDisplayHTML(Object obj_p, OwTreeView.OwTreeViewNode node_p) Returns HTML code to be used to display a node. If you override this method, you have to make sure that the HTML code is properly encoded!
protected String	getDisplayName(Object obj_p, OwTreeView.OwTreeViewNode node_p) Returns the text to be displayed as the name of the node. This text will be properly encoded before used.
protected String	getName(Object obj_p, OwTreeView.OwTreeViewNode node_p) get the name for an object, used to build paths to be implemented by the derived class
protected String	getOpenIconURL(Object obj_p, OwTreeView.OwTreeViewNode node_p) get a URL to the open icon to be implemented by the derived class
protected boolean	hasPlusMinusIcon(Object obj_p, OwTreeView.OwTreeViewNode node_p) (overridable) check of node has subnodes to be overwritten by the derived class
protected void	init() init the target after the context is set.
boolean	isDynamicSplitUsed() Getter for flag m_isDynamicSplitUsed.
void	navigateChildObject(OwObject obj_p) navigate to the given child object
void	setIsDynamicSplitUsed(boolean isynamicSplitUsed_p) Setter for flag m_isDynamicSplitUsed.
void	setMaxChildSize(int iMaxChildSize_p) set maximum number of child nodes

Methods inherited from class com.wewebu.ow.server.ui.OwTreeView

addNode, canNavigate, clearSelection, createTreeViewNode, getChildrenSort, getClientSideId, getCurrentNode, getDisplayMode, getNodeForObject, getNodeFromID, getRegisterItemStyle, getSelectedRegisterItemStyle, getSelectedTreeItemStyle, getTreeItemStyle, isEmpty, isEnabled, isFocused, isSelected, navigate, navigate, navigateToChild, navigateToId, navigateUp, onClickLabel, onClickPlusMinus, onRender, openNode, refreshCurrentNode, refreshNodeForObject, renderFolderIconLink, renderMinusIconLink, renderNode, renderNodeLink, renderPlusIconLink, renderRegister, setChildrenSort, setDisplayMode, setEventListner, useFormEventUrls, writeTooltip

Methods inherited from class com.wewebu.ow.server.ui.OwView

activate, addView, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, renderNamedRegion, renderRegion, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes

Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget

attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget

Methods inherited from class java.lang.Object

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

Field Detail

m_Configuration

protected OwConfiguration m_Configuration

application m_Configuration reference

m_iMaxChildSize

protected int m_iMaxChildSize

maximum number of child nodes

Constructor Detail

OwObjectTreeView

public OwObjectTreeView()

Method Detail

init

protected void init()
             throws Exception

init the target after the context is set.

Overrides:

init in class OwTreeView

Throws:

Exception

setMaxChildSize

public void setMaxChildSize(int iMaxChildSize_p)

set maximum number of child nodes

navigateChildObject

public void navigateChildObject(OwObject obj_p)
                         throws Exception

navigate to the given child object

Parameters:

obj_p - Child OwObject to navigate to

Throws:

Exception

createChildObjects

protected List createChildObjects(Object obj_p)
                           throws Exception

Create a list of child objects to the given object. The children are ordered using the OwSort object (@see OwTreeView.getChildrenSort()).

Specified by:

createChildObjects in class OwTreeView

Parameters:

obj_p - Object which is managed by the tree view

Returns:

List of Objects which are child to the given object

Throws:

Exception

getCloseIconURL

protected String getCloseIconURL(Object obj_p,
                                 OwTreeView.OwTreeViewNode node_p)
                          throws Exception

get a URL to the close icon to be implemented by the derived class

Overrides:

getCloseIconURL in class OwTreeView

Parameters:

obj_p - Object which is managed by the tree view

node_p - OwTreeViewNode

Returns:

String URL to the close icon

Throws:

Exception

getOpenIconURL

protected String getOpenIconURL(Object obj_p,
                                OwTreeView.OwTreeViewNode node_p)
                         throws Exception

get a URL to the open icon to be implemented by the derived class

Overrides:

getOpenIconURL in class OwTreeView

Parameters:

obj_p - Object which is managed by the tree view

node_p - OwTreeViewNode

Returns:

String URL to the close icon

Throws:

Exception

getName

protected String getName(Object obj_p,
                         OwTreeView.OwTreeViewNode node_p)
                  throws Exception

get the name for an object, used to build paths to be implemented by the derived class

Specified by:

getName in class OwTreeView

Parameters:

obj_p - Object which is managed by the tree view

Returns:

the name for an object

Throws:

Exception

getDisplayName

protected String getDisplayName(Object obj_p,
                                OwTreeView.OwTreeViewNode node_p)
                         throws Exception

Returns the text to be displayed as the name of the node.
This text will be properly encoded before used.

Overrides:

getDisplayName in class OwTreeView

Parameters:

obj_p - Object which is managed by the tree view

node_p - the node to return the text for

Returns:

the text to be displayed as the name of the node.

Throws:

Exception

getDisplayHTML

protected String getDisplayHTML(Object obj_p,
                                OwTreeView.OwTreeViewNode node_p)
                         throws Exception

Returns HTML code to be used to display a node.
If you override this method, you have to make sure that the HTML code is properly encoded!

Overrides:

getDisplayHTML in class OwTreeView

Parameters:

obj_p - Object which is managed by the tree view

node_p - the node to return the text for

Returns:

HTML code to be used to display a node

Throws:

Exception

Since:

2.5.3.0

hasPlusMinusIcon

protected boolean hasPlusMinusIcon(Object obj_p,
                                   OwTreeView.OwTreeViewNode node_p)
                            throws Exception

(overridable) check of node has subnodes to be overwritten by the derived class

Overrides:

hasPlusMinusIcon in class OwTreeView

Parameters:

obj_p - Object which is managed by the tree view

Returns:

true if plus minus icon should be displayed to open subnodes

Throws:

Exception

setIsDynamicSplitUsed

public void setIsDynamicSplitUsed(boolean isynamicSplitUsed_p)

Setter for flag m_isDynamicSplitUsed.

Parameters:

isynamicSplitUsed_p - - the flag value

Since:

3.1.0.0

isDynamicSplitUsed

public boolean isDynamicSplitUsed()

Getter for flag m_isDynamicSplitUsed.

Returns:

- true if the dynamic split is used.

Since:

3.1.0.0

expandParents

protected void expandParents(Object theObject_p)
                      throws Exception

Description copied from class: OwTreeView

Expand the parents of the current object

Specified by:

expandParents in class OwTreeView

Throws:

Exception