org.exoplatform.ecm.webui.presentation

Class UIBaseNodePresentation

java.lang.Object

org.exoplatform.webui.core.UIComponent

org.exoplatform.webui.core.UIContainer

org.exoplatform.portal.webui.portal.UIPortalComponent

org.exoplatform.portal.webui.container.UIContainer

org.exoplatform.ecm.webui.presentation.UIBaseNodePresentation

All Implemented Interfaces:

NodePresentation

Direct Known Subclasses:

UIContentViewer, UIDocumentInfo, UIPresentation, UIVersionViewer, UIViewSearchResult, UIViewVersion

public abstract class UIBaseNodePresentation
extends org.exoplatform.portal.webui.container.UIContainer
implements NodePresentation

The Class UIBaseNodePresentation should implement some common method in NodePresentation like getIcons,getWebDavLink....

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIBaseNodePresentation.OpenDocInDesktopActionListener

Nested classes/interfaces inherited from class org.exoplatform.webui.core.UIContainer

org.exoplatform.webui.core.UIContainer.SelectTabActionListener

Field Summary

Fields inherited from class org.exoplatform.portal.webui.container.UIContainer

description, icon, moveAppsPermissions, moveContainersPermissions, TABLE_COLUMN_CONTAINER

Fields inherited from class org.exoplatform.portal.webui.portal.UIPortalComponent

COMPONENT_EDIT_MODE, COMPONENT_VIEW_MODE, factoryId, height_, mode_, name_, template_, width_

Fields inherited from class org.exoplatform.webui.core.UIComponent

AJAX_ASYNC, config, OBJECTID, UICOMPONENT, uiparent

Fields inherited from interface org.exoplatform.ecm.webui.presentation.NodePresentation

MEDIA_STATE_DISPLAY, MEDIA_STATE_NONE

Constructor Summary

Constructors

Constructor and Description
UIBaseNodePresentation()

Method Summary

Modifier and Type	Method and Description
String	encodeHTML(String text) Encode html.
String	getActionOpenDocInDesktop()
List<javax.jcr.Node>	getAttachments() Gets the attachments.
List<javax.jcr.Node>	getCategories(javax.jcr.Node node) Retrieve all categories of a node.
List<javax.jcr.Node>	getComments() Gets the comments.
Object	getComponentInstanceOfType(String className) Gets the component instance of type.
String	getDownloadLink(javax.jcr.Node node) Gets the download link.
String	getIcons(javax.jcr.Node node, String size) Gets the icons.
String	getImage(javax.jcr.Node node) Gets the image.
String	getImageURIInProperty(javax.jcr.Node node, String propertyName) Retrieve the image in property value.
String	getInlineEditingField(javax.jcr.Node orgNode, String propertyName)
String	getInlineEditingField(javax.jcr.Node orgNode, String propertyName, String defaultValue, String inputType, String idGenerator, String cssClass, boolean isGenericProperty, String... arguments)
String	getLanguage() Gets the language.
String	getMediaState() gets the status of display audio description for accessible media
abstract javax.jcr.Node	getNode() Gets the node.
javax.jcr.Node	getNodeByUUID(String uuid) Gets the node by uuid.
abstract javax.jcr.Node	getOriginalNode() Gets the original node.
org.exoplatform.webui.core.UIPopupContainer	getPopupContainer()
String	getPortalName() Gets the portal name.
String	getPortletPreferenceValue(String preferenceName) Retrieve the portlet preference value.
String[]	getPortletPreferenceValues(String preferenceName) Retrieve the portlet preference values.
String	getPostedTimeString(org.exoplatform.webui.core.lifecycle.WebuiBindingContext resourceBundle, Date postedTime)
List<javax.jcr.Node>	getRelations() Gets the relations.
String	getRepository() Gets the repository.
String	getRepositoryName() Gets the repository name.
String	getRssLink() Gets the rss link.
List<javax.jcr.Node>	getSortedComments()
List	getSupportedLocalise() Gets the supported localise.
List<javax.jcr.Node>	getTags(javax.jcr.Node node) Retrieve all tags of a node.
abstract String	getTemplatePath() Gets the template path.
String	getTemplateSkin(String nodeTypeName, String skinName) Get the skin of template if it's existing
String	getViewableLink(javax.jcr.Node attNode, org.exoplatform.web.application.Parameter[] params) Gets the viewable link.
String	getViewTemplate(String nodeTypeName, String templateName) Gets the view template.
long	getVotingRate(javax.jcr.Node node) Retrieve the voting rate.
String	getWebDAVServerPrefix() Gets the web dav server prefix.
String	getWorkspaceName() Gets the workspace name.
boolean	isDisplayAlternativeText()
boolean	isEnableComment() checks if enable comment
boolean	isEnableVote() checks if enable vote
boolean	isFastPublishLink() Checks if allow render fast publish link for the inline editting
boolean	isRssLink() Checks if is rss link.
boolean	playAudioDescription()
void	setEnableComment(boolean value) Sets enable comment
void	setEnableVote(boolean value) Sets enable vote
void	setLanguage(String language) Sets the language.
boolean	switchBackAudioDescription()
void	switchMediaState() switches the status of display audio description for accessible media

Methods inherited from class org.exoplatform.portal.webui.container.UIContainer

getDescription, getIcon, getMoveAppsPermissions, getMoveContainersPermissions, getPermissionClasses, getStorageId, hasMoveAppsPermission, hasMoveContainersPermission, setDescription, setIcon, setMoveAppsPermissions, setMoveContainersPermissions, setStorageId

Methods inherited from class org.exoplatform.portal.webui.portal.UIPortalComponent

getAccessPermissions, getFactoryId, getHeight, getName, getTemplate, getTitle, getWidth, hasAccessPermission, hasPermission, isModifiable, setAccessPermissions, setFactoryId, setHeight, setModifiable, setName, setTemplate, setTitle, setWidth

Methods inherited from class org.exoplatform.webui.core.UIContainer

addChild, addChild, findComponentById, findComponentOfType, findFirstComponentOfType, getChild, getChild, getChildById, getChildren, hasChildren, removeChild, removeChildById, renderChild, renderChild, renderChild, renderChild, renderChildren, renderChildren, renderUIComponent, replaceChild, replaceChild, setChildren, setRenderedChild, setRenderedChild, setRenderedChildrenOfTypes

Methods inherited from class org.exoplatform.webui.core.UIComponent

broadcast, buildModelObject, createEvent, createUIComponent, createUIComponent, createUIComponent, doAsync, event, event, event, getAncestorOfType, getApplicationComponent, getComponentConfig, getId, getParent, getTemplateResourceResolver, getUIComponentName, isRendered, loadConfirmMesssage, processAction, processDecode, processRender, renderEventURL, setComponentConfig, setComponentConfig, setId, setParent, setRendered, setRenderSibling, url, url, url

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.exoplatform.ecm.webui.presentation.NodePresentation

getCommentComponent, getNodeType, getRemoveAttach, getRemoveComment, getUIComponent, isNodeTypeSupported, setNode

Constructor Detail

UIBaseNodePresentation

public UIBaseNodePresentation()

Method Detail

getNode

public abstract javax.jcr.Node getNode()
                                throws Exception

Description copied from interface: NodePresentation

Gets the node.

Specified by:

getNode in interface NodePresentation

Returns:

the node

Throws:

Exception - the exception

getTemplatePath

public abstract String getTemplatePath()
                                throws Exception

Description copied from interface: NodePresentation

Gets the template path.

Specified by:

getTemplatePath in interface NodePresentation

Returns:

the template path

Throws:

Exception - the exception

getOriginalNode

public abstract javax.jcr.Node getOriginalNode()
                                        throws Exception

Description copied from interface: NodePresentation

Gets the original node.

Specified by:

getOriginalNode in interface NodePresentation

Returns:

the original node

Throws:

Exception - the exception

getRepositoryName

public String getRepositoryName()
                         throws Exception

Gets the repository name.

Returns:

the repository name

Throws:

Exception - the exception

encodeHTML

public String encodeHTML(String text)
                  throws Exception

Description copied from interface: NodePresentation

Encode html.

Specified by:

encodeHTML in interface NodePresentation

Parameters:

text - the text

Returns:

the string

Throws:

Exception - the exception

getAttachments

public List<javax.jcr.Node> getAttachments()
                                    throws Exception

Description copied from interface: NodePresentation

Gets the attachments.

Specified by:

getAttachments in interface NodePresentation

Returns:

the attachments

Throws:

Exception - the exception

getViewableLink

public String getViewableLink(javax.jcr.Node attNode,
                              org.exoplatform.web.application.Parameter[] params)
                       throws Exception

Description copied from interface: NodePresentation

Gets the viewable link.

Specified by:

getViewableLink in interface NodePresentation

Returns:

the viewable URL

Throws:

Exception - the exception

getComments

public List<javax.jcr.Node> getComments()
                                 throws Exception

Description copied from interface: NodePresentation

Gets the comments.

Specified by:

getComments in interface NodePresentation

Returns:

the comments

Throws:

Exception - the exception

getSortedComments

public List<javax.jcr.Node> getSortedComments()
                                       throws Exception

Throws:

Exception

getComponentInstanceOfType

public Object getComponentInstanceOfType(String className)

Description copied from interface: NodePresentation

Gets the component instance of type.

Specified by:

getComponentInstanceOfType in interface NodePresentation

Parameters:

className - the class name

Returns:

the component instance of type

getDownloadLink

public String getDownloadLink(javax.jcr.Node node)
                       throws Exception

Description copied from interface: NodePresentation

Gets the download link.

Specified by:

getDownloadLink in interface NodePresentation

Parameters:

node - the node

Returns:

the download link

Throws:

Exception - the exception

getIcons

public String getIcons(javax.jcr.Node node,
                       String size)
                throws Exception

Description copied from interface: NodePresentation

Gets the icons.

Specified by:

getIcons in interface NodePresentation

Parameters:

node - the node

size - the size

Returns:

the icons

Throws:

Exception - the exception

getImage

public String getImage(javax.jcr.Node node)
                throws Exception

Description copied from interface: NodePresentation

Gets the image.

Specified by:

getImage in interface NodePresentation

Parameters:

node - the node

Returns:

the image

Throws:

Exception - the exception

getLanguage

public String getLanguage()

Description copied from interface: NodePresentation

Gets the language.

Specified by:

getLanguage in interface NodePresentation

Returns:

the language

setLanguage

public void setLanguage(String language)

Description copied from interface: NodePresentation

Sets the language.

Specified by:

setLanguage in interface NodePresentation

Parameters:

language - the new language

getPortalName

public String getPortalName()

Description copied from interface: NodePresentation

Gets the portal name.

Specified by:

getPortalName in interface NodePresentation

Returns:

the portal name

getRelations

public List<javax.jcr.Node> getRelations()
                                  throws Exception

Description copied from interface: NodePresentation

Gets the relations.

Specified by:

getRelations in interface NodePresentation

Returns:

the relations

Throws:

Exception - the exception

getRepository

public String getRepository()
                     throws Exception

Description copied from interface: NodePresentation

Gets the repository.

Specified by:

getRepository in interface NodePresentation

Returns:

the repository

Throws:

Exception - the exception

getRssLink

public String getRssLink()

Description copied from interface: NodePresentation

Gets the rss link.

Specified by:

getRssLink in interface NodePresentation

Returns:

the rss link

isRssLink

public boolean isRssLink()

Description copied from interface: NodePresentation

Checks if is rss link.

Specified by:

isRssLink in interface NodePresentation

Returns:

true, if is rss link

isFastPublishLink

public boolean isFastPublishLink()

Checks if allow render fast publish link for the inline editting

Returns:

true, if need to render fast publish link

getSupportedLocalise

public List getSupportedLocalise()
                          throws Exception

Description copied from interface: NodePresentation

Gets the supported localise.

Specified by:

getSupportedLocalise in interface NodePresentation

Returns:

the supported localise

Throws:

Exception - the exception

getViewTemplate

public String getViewTemplate(String nodeTypeName,
                              String templateName)
                       throws Exception

Description copied from interface: NodePresentation

Gets the view template.

Specified by:

getViewTemplate in interface NodePresentation

Parameters:

nodeTypeName - the node type name

templateName - the template name

Returns:

the view template

Throws:

Exception - the exception

getWebDAVServerPrefix

public String getWebDAVServerPrefix()
                             throws Exception

Description copied from interface: NodePresentation

Gets the web dav server prefix.

Specified by:

getWebDAVServerPrefix in interface NodePresentation

Returns:

the web dav server prefix

Throws:

Exception - the exception

getWorkspaceName

public String getWorkspaceName()
                        throws Exception

Description copied from interface: NodePresentation

Gets the workspace name.

Specified by:

getWorkspaceName in interface NodePresentation

Returns:

the workspace name

Throws:

Exception - the exception

getNodeByUUID

public javax.jcr.Node getNodeByUUID(String uuid)

Gets the node by uuid.

Parameters:

uuid - the uuid

Returns:

the node by uuid

getCategories

public List<javax.jcr.Node> getCategories(javax.jcr.Node node)
                                   throws Exception

Retrieve all categories of a node.

Parameters:

node - the node

Returns:

the categories

Throws:

Exception - the exception

getTags

public List<javax.jcr.Node> getTags(javax.jcr.Node node)
                             throws Exception

Retrieve all tags of a node.

Parameters:

node - the node

Returns:

the tags

Throws:

Exception - the exception

getVotingRate

public long getVotingRate(javax.jcr.Node node)
                   throws Exception

Retrieve the voting rate.

Parameters:

node - the node

Returns:

the votes

Throws:

Exception - the exception

getImageURIInProperty

public String getImageURIInProperty(javax.jcr.Node node,
                                    String propertyName)
                             throws Exception

Retrieve the image in property value.

Parameters:

node - the node

propertyName - the property name

Returns:

the image in property

Throws:

Exception - the exception

getPortletPreferenceValue

public String getPortletPreferenceValue(String preferenceName)

Retrieve the portlet preference value.

Parameters:

preferenceName - the preference name

Returns:

the portlet preference value

getPortletPreferenceValues

public String[] getPortletPreferenceValues(String preferenceName)

Retrieve the portlet preference values.

Parameters:

preferenceName - the preference name

Returns:

the portlet preference values

getTemplateSkin

public String getTemplateSkin(String nodeTypeName,
                              String skinName)
                       throws Exception

Description copied from interface: NodePresentation

Get the skin of template if it's existing

Specified by:

getTemplateSkin in interface NodePresentation

Parameters:

nodeTypeName - The node type name

skinName - Skin name

Returns:

The skin template

Throws:

Exception

isEnableComment

public boolean isEnableComment()

Description copied from interface: NodePresentation

checks if enable comment

Specified by:

isEnableComment in interface NodePresentation

isEnableVote

public boolean isEnableVote()

Description copied from interface: NodePresentation

checks if enable vote

Specified by:

isEnableVote in interface NodePresentation

setEnableComment

public void setEnableComment(boolean value)

Description copied from interface: NodePresentation

Sets enable comment

Specified by:

setEnableComment in interface NodePresentation

Parameters:

value - value to set

setEnableVote

public void setEnableVote(boolean value)

Description copied from interface: NodePresentation

Sets enable vote

Specified by:

setEnableVote in interface NodePresentation

Parameters:

value - value to set

getInlineEditingField

public String getInlineEditingField(javax.jcr.Node orgNode,
                                    String propertyName,
                                    String defaultValue,
                                    String inputType,
                                    String idGenerator,
                                    String cssClass,
                                    boolean isGenericProperty,
                                    String... arguments)
                             throws Exception

Specified by:

getInlineEditingField in interface NodePresentation

Parameters:

orgNode - Processed node

propertyName - which property used for editing

inputType - input type for editing: TEXT, TEXTAREA, WYSIWYG

cssClass - class name for CSS, should implement: cssClass, [cssClass]Title Edit[cssClass] as relative css Should create the function: InlineEditor.presentationRequestChange[cssClass] to request the rest-service

isGenericProperty - set as true to use generic javascript function, other wise, must create the correctspond function InlineEditor.presentationRequestChange[cssClass]

arguments - Extra parameter for Input component (toolbar, width, height,.. for CKEditor/TextArea)

Returns:

String that can be put on groovy template

Throws:

Exception

getInlineEditingField

public String getInlineEditingField(javax.jcr.Node orgNode,
                                    String propertyName)
                             throws Exception

Specified by:

getInlineEditingField in interface NodePresentation

Throws:

Exception

getMediaState

public String getMediaState()

Description copied from interface: NodePresentation

gets the status of display audio description for accessible media

Specified by:

getMediaState in interface NodePresentation

Returns:

status of display audio description for accessible media

switchMediaState

public void switchMediaState()

Description copied from interface: NodePresentation

switches the status of display audio description for accessible media

Specified by:

switchMediaState in interface NodePresentation

isDisplayAlternativeText

public boolean isDisplayAlternativeText()

Specified by:

isDisplayAlternativeText in interface NodePresentation

Returns:

true if node can display audio description

playAudioDescription

public boolean playAudioDescription()

Specified by:

playAudioDescription in interface NodePresentation

Returns:

true if can switch to play audio description of the media

switchBackAudioDescription

public boolean switchBackAudioDescription()

Specified by:

switchBackAudioDescription in interface NodePresentation

Returns:

true if can switch back from original node from audio description

getActionOpenDocInDesktop

public String getActionOpenDocInDesktop()
                                 throws Exception

Specified by:

getActionOpenDocInDesktop in interface NodePresentation

Throws:

Exception

getPopupContainer

public org.exoplatform.webui.core.UIPopupContainer getPopupContainer()
                                                              throws Exception

Specified by:

getPopupContainer in interface NodePresentation

Throws:

Exception

getPostedTimeString

public String getPostedTimeString(org.exoplatform.webui.core.lifecycle.WebuiBindingContext resourceBundle,
                                  Date postedTime)
                           throws Exception

Throws:

Exception