public class OwObjectTreeViewEXTJS extends OwObjectTreeView
Object tree based on EXT-JS tree view.
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
Modifier and Type | Class and Description |
---|---|
class |
OwObjectTreeViewEXTJS.OwTreeViewNodeJS
Tree node representation used by
OwObjectTreeViewEXTJS . |
OwTreeView.OwTreeViewEventListner, OwTreeView.OwTreeViewNode
Modifier and Type | Field and Description |
---|---|
protected static String |
FOLDER_CLOSE_CSS_CLASS
the CSS class for rendering close folder icon
|
protected static String |
FOLDER_OPEN_CSS_CLASS
the CSS class for rendering open folder icon
|
m_Configuration, m_iMaxChildSize
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
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
EMPTY_STRING
Constructor and Description |
---|
OwObjectTreeViewEXTJS() |
Modifier and Type | Method and Description |
---|---|
void |
addComponentUpdateURL(String elementId_p,
String updateLink_p)
Add the corresponding update URL for the given element ID.
|
protected OwTreeView.OwTreeViewNode |
createTreeViewNode(OwTreeView treeView_p,
Object obj_p)
overridable factory method check of node has subnodes to be overwritten
by the derived class
|
String |
getCannotLoadNodeText()
Returns the localized error message when subnodes of a node cannot be loaded.
|
String |
getCollapseStacktraceMessage()
Returns the localized message for collapsing the stacktrace.
|
OwTreeView.OwTreeViewNode |
getCurrentSelectedNode()
Get the current selected node.
|
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! |
String |
getDnDAppletURL() |
String |
getErrorTitleText()
Returns the localized title for error boxes.
|
String |
getExternalUpdateURL()
Get the URL that resolve the AJAX request when a node is clicked.
|
String |
getLoadingMessage()
Returns the localized loading message.
|
String |
getRequestTimeOutText()
Returns the localized error message for request timeout.
|
String |
getRootClosedIcon()
Get the closed icon URL for the root item.
|
String |
getRootIcon()
Returns the URL to the root icon.
|
String |
getRootIconClass()
Get the CSS class for icon of root folder.
|
String |
getRootId()
Get the id of the root node.
|
String |
getRootOpenedIcon()
Get the closed icon URL for the root item.
|
String |
getRootText()
Get the root displayable text.
|
String |
getSelectedId()
Get the id of selected node.
|
String |
getSelectedPathIds()
Returns a JavaScript array of IDs in the selected path.
|
String |
getShowStacktraceMessage()
Returns the localized message for showing the stacktrace.
|
String |
getUpdateComponentIds()
Get a prepared JavaScript array with identifiers for HTML elements that need to be updated using an AJAX request.
|
String |
getUpdateComponentsURLs()
Get a prepared JavaScript array the JavaScript array with update URL for HTML elements that need to be updated.
|
String |
getUpdateErrorText()
Returns the localized part preceding the real error cause for update error.
|
boolean |
isExpandOnSelect()
Get the tree node behavior when selected.
|
boolean |
isIconClassInUse()
Get the configuration flag that specify if icons in the tree are rendered using the icon CSS class.
|
boolean |
isSelectedNodeExpanded()
Get the status of the current node.
|
void |
navigate(Object obj_p,
String strPath_p)
init the tree and set the root object
|
void |
navigateToId(String nodeId_p)
Navigate to the specific node id
|
protected void |
onActivate(int index_p,
Object reason_p)
activate the target from a navigation module.
|
void |
onAjaxGetTreeData(javax.servlet.http.HttpServletRequest request_p,
javax.servlet.http.HttpServletResponse response_p)
Method called when the tree is loading.
|
void |
onAjaxNodeCollapsed(javax.servlet.http.HttpServletRequest request_p,
javax.servlet.http.HttpServletResponse response_p)
Update the server collapsed state for the node.
|
protected void |
onRender(Writer w_p)
called when the view should create its HTML content to be displayed
|
protected void |
renderMainRegion(Writer w_p) |
void |
setDnDAppletURL(String dnDAppletURL) |
void |
setExpandOnSelect(boolean expandOnSelect_p)
Set the behavior of the tree node when is selected.
|
void |
setExternalUpdateURL(String externalUpdateURL_p)
Set the URL that resolve the AJAX request when a node is clicked.
|
void |
setIconClassInUse(boolean useIconClass_p)
Set the flag that specify if icons in the tree are rendered using the icon CSS class.
|
createChildObjects, expandParents, getCloseIconURL, getDisplayName, getName, getOpenIconURL, hasPlusMinusIcon, init, isDynamicSplitUsed, navigateChildObject, setIsDynamicSplitUsed, setMaxChildSize
addNode, canNavigate, clearSelection, getChildrenSort, getClientSideId, getCurrentNode, getDisplayMode, getNodeForObject, getNodeFromID, getRegisterItemStyle, getSelectedRegisterItemStyle, getSelectedTreeItemStyle, getTreeItemStyle, isEmpty, isEnabled, isFocused, isSelected, navigate, navigateToChild, navigateUp, onClickLabel, onClickPlusMinus, openNode, refreshCurrentNode, refreshNodeForObject, renderFolderIconLink, renderMinusIconLink, renderNode, renderNodeLink, renderPlusIconLink, renderRegister, setChildrenSort, setDisplayMode, setEventListner, useFormEventUrls, writeTooltip
activate, addView, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMaximized, isShowMinimized, isShowNormal, onUpdate, render, renderHTMLFormular, renderNamedRegion, renderRegion, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget
protected static final String FOLDER_CLOSE_CSS_CLASS
protected static final String FOLDER_OPEN_CSS_CLASS
protected void onRender(Writer w_p) throws Exception
OwTreeView
onRender
in class OwTreeView
w_p
- Writer object to write HTML toException
protected void renderMainRegion(Writer w_p) throws Exception
w_p
- Writer to write toException
public void onAjaxNodeCollapsed(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p) throws Exception
request_p
- response_p
- Exception
public void onAjaxGetTreeData(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p) throws Exception
request_p
- - the AJAX requestresponse_p
- - the responseException
public String getRootIconClass()
public String getRootText() throws Exception
Exception
public String getRootId()
protected String getDisplayHTML(Object obj_p, OwTreeView.OwTreeViewNode node_p) throws Exception
OwObjectTreeView
getDisplayHTML
in class OwObjectTreeView
obj_p
- Object which is managed by the tree viewnode_p
- the node to return the text forException
protected OwTreeView.OwTreeViewNode createTreeViewNode(OwTreeView treeView_p, Object obj_p)
OwTreeView
createTreeViewNode
in class OwTreeView
treeView_p
- OwTreeViewobj_p
- template Object which is managed by the tree nodepublic String getExternalUpdateURL()
public void setExternalUpdateURL(String externalUpdateURL_p)
externalUpdateURL_p
- - the URLpublic String getSelectedId()
public String getSelectedPathIds()
String
object representing the JavaScript array of IDs in the selected path.public String getRootIcon() throws Exception
Exception
public void addComponentUpdateURL(String elementId_p, String updateLink_p)
elementId_p
- - the DOM id for the container to be updatedupdateLink_p
- - the URL where the update AJAX request will be send.public String getUpdateComponentIds()
public String getUpdateComponentsURLs()
public String getRootClosedIcon() throws Exception
Exception
public String getRootOpenedIcon() throws Exception
Exception
public boolean isIconClassInUse()
public void setIconClassInUse(boolean useIconClass_p)
useIconClass_p
is true
, the designer has the possibility
to configure the icons for folder closed or folder opened via FOLDER_CLOSE_CSS_CLASS
or via FOLDER_OPEN_CSS_CLASS
CSS classes.useIconClass_p
- - if true
the folder icons are configured via CSS style classes (FOLDER_CLOSE_CSS_CLASS
or FOLDER_OPEN_CSS_CLASS
), otherwise the MIME icons are used for folder icons.public String getLoadingMessage()
public String getErrorTitleText()
public String getUpdateErrorText()
public String getRequestTimeOutText()
public String getCannotLoadNodeText()
public String getShowStacktraceMessage()
public String getCollapseStacktraceMessage()
public void setExpandOnSelect(boolean expandOnSelect_p)
expandOnSelect_p
- - if true
when a codepublic boolean isExpandOnSelect()
public void navigateToId(String nodeId_p) throws Exception
OwTreeView
navigateToId
in class OwTreeView
nodeId_p
- String representing id of the nodeException
public void navigate(Object obj_p, String strPath_p) throws Exception
OwTreeView
navigate
in class OwTreeView
obj_p
- Root Object to be managed by the treestrPath_p
- String representing pathException
OwTreeView.navigate(java.lang.Object, java.lang.String)
public boolean isSelectedNodeExpanded()
public OwTreeView.OwTreeViewNode getCurrentSelectedNode()
protected void onActivate(int index_p, Object reason_p) throws Exception
OwView
onActivate
in class OwView
index_p
- int tab iIndex of Navigationreason_p
- User Object which was submitted when target was attached to the navigation moduleException
public String getDnDAppletURL()
public void setDnDAppletURL(String dnDAppletURL)
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.