org.exoplatform.ecm.webui.presentation

Interface NodePresentation

All Known Implementing Classes:

UIBaseNodePresentation, UIContentViewer, UIDocumentInfo, UIDocumentWithTree, UIPresentation, UIVersionViewer, UIViewSearchResult, UIViewVersion

public interface NodePresentation

Created by The eXo Platform SARL Author : Dang Van Minh minh.dang@exoplatform.com May 8, 2008 3:22:08 PM

Field Summary

Fields

Modifier and Type	Field and Description
static String	MEDIA_STATE_DISPLAY
static String	MEDIA_STATE_NONE

Method Summary

Modifier and Type	Method and Description
String	encodeHTML(String text) Encode html.
String	getActionOpenDocInDesktop()
List<javax.jcr.Node>	getAttachments() Gets the attachments.
org.exoplatform.webui.core.UIComponent	getCommentComponent() Get UIComponent for comment
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	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
javax.jcr.Node	getNode() Gets the node.
String	getNodeType() Gets the node type.
javax.jcr.Node	getOriginalNode() Gets the original node.
org.exoplatform.webui.core.UIPopupContainer	getPopupContainer()
String	getPortalName() Gets the portal name.
List<javax.jcr.Node>	getRelations() Gets the relations.
org.exoplatform.webui.core.UIComponent	getRemoveAttach() Get UIComponent to remove attachment in document
org.exoplatform.webui.core.UIComponent	getRemoveComment() Get UIComponent to remove comment in document
String	getRepository() Gets the repository.
String	getRssLink() Gets the rss link.
List	getSupportedLocalise() Gets the supported localise.
String	getTemplatePath() Gets the template path.
String	getTemplateSkin(String nodeTypeName, String skinName) Get the skin of template if it's existing
org.exoplatform.webui.core.UIComponent	getUIComponent(String mimeType) Get the UIComponent which to display file
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.
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	isNodeTypeSupported() Checks if is node type supported.
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.
void	setNode(javax.jcr.Node node) Sets the node.
boolean	switchBackAudioDescription()
void	switchMediaState() switches the status of display audio description for accessible media

Field Detail

MEDIA_STATE_DISPLAY

static final String MEDIA_STATE_DISPLAY

See Also:

Constant Field Values

MEDIA_STATE_NONE

static final String MEDIA_STATE_NONE

See Also:

Constant Field Values

Method Detail

setEnableVote

void setEnableVote(boolean value)

Sets enable vote

Parameters:

value - value to set

isEnableVote

boolean isEnableVote()

checks if enable vote

setEnableComment

void setEnableComment(boolean value)

Sets enable comment

Parameters:

value - value to set

isEnableComment

boolean isEnableComment()

checks if enable comment

setNode

void setNode(javax.jcr.Node node)

Sets the node.

Parameters:

node - the new node

getNode

javax.jcr.Node getNode()
                throws Exception

Gets the node.

Returns:

the node

Throws:

Exception - the exception

getOriginalNode

javax.jcr.Node getOriginalNode()
                        throws Exception

Gets the original node.

Returns:

the original node

Throws:

Exception - the exception

getNodeType

String getNodeType()
            throws Exception

Gets the node type.

Returns:

the node type

Throws:

Exception - the exception

isNodeTypeSupported

boolean isNodeTypeSupported()

Checks if is node type supported.

Returns:

true, if is node type supported

getTemplatePath

String getTemplatePath()
                throws Exception

Gets the template path.

Returns:

the template path

Throws:

Exception - the exception

getRelations

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

Gets the relations.

Returns:

the relations

Throws:

Exception - the exception

getAttachments

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

Gets the attachments.

Returns:

the attachments

Throws:

Exception - the exception

getViewableLink

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

Gets the viewable link.

Returns:

the viewable URL

Throws:

Exception - the exception

isRssLink

boolean isRssLink()

Checks if is rss link.

Returns:

true, if is rss link

getRssLink

String getRssLink()

Gets the rss link.

Returns:

the rss link

getSupportedLocalise

List getSupportedLocalise()
                   throws Exception

Gets the supported localise.

Returns:

the supported localise

Throws:

Exception - the exception

setLanguage

void setLanguage(String language)

Sets the language.

Parameters:

language - the new language

getLanguage

String getLanguage()

Gets the language.

Returns:

the language

getComponentInstanceOfType

Object getComponentInstanceOfType(String className)

Gets the component instance of type.

Parameters:

className - the class name

Returns:

the component instance of type

getWebDAVServerPrefix

String getWebDAVServerPrefix()
                      throws Exception

Gets the web dav server prefix.

Returns:

the web dav server prefix

Throws:

Exception - the exception

getImage

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

Gets the image.

Parameters:

node - the node

Returns:

the image

Throws:

Exception - the exception

getPortalName

String getPortalName()

Gets the portal name.

Returns:

the portal name

getRepository

String getRepository()
              throws Exception

Gets the repository.

Returns:

the repository

Throws:

Exception - the exception

getWorkspaceName

String getWorkspaceName()
                 throws Exception

Gets the workspace name.

Returns:

the workspace name

Throws:

Exception - the exception

getViewTemplate

String getViewTemplate(String nodeTypeName,
                       String templateName)
                throws Exception

Gets the view template.

Parameters:

nodeTypeName - the node type name

templateName - the template name

Returns:

the view template

Throws:

Exception - the exception

getTemplateSkin

String getTemplateSkin(String nodeTypeName,
                       String skinName)
                throws Exception

Get the skin of template if it's existing

Parameters:

nodeTypeName - The node type name

skinName - Skin name

Returns:

The skin template

Throws:

Exception

getCommentComponent

org.exoplatform.webui.core.UIComponent getCommentComponent()
                                                    throws Exception

Get UIComponent for comment

Returns:

Throws:

Exception

getRemoveAttach

org.exoplatform.webui.core.UIComponent getRemoveAttach()
                                                throws Exception

Get UIComponent to remove attachment in document

Returns:

Throws:

Exception

getRemoveComment

org.exoplatform.webui.core.UIComponent getRemoveComment()
                                                 throws Exception

Get UIComponent to remove comment in document

Returns:

Throws:

Exception

getComments

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

Gets the comments.

Returns:

the comments

Throws:

Exception - the exception

getDownloadLink

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

Gets the download link.

Parameters:

node - the node

Returns:

the download link

Throws:

Exception - the exception

encodeHTML

String encodeHTML(String text)
           throws Exception

Encode html.

Parameters:

text - the text

Returns:

the string

Throws:

Exception - the exception

getIcons

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

Gets the icons.

Parameters:

node - the node

size - the size

Returns:

the icons

Throws:

Exception - the exception

getUIComponent

org.exoplatform.webui.core.UIComponent getUIComponent(String mimeType)
                                               throws Exception

Get the UIComponent which to display file

Parameters:

mimeType -

Returns:

Throws:

Exception

getInlineEditingField

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

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

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

Throws:

Exception

getMediaState

String getMediaState()

gets the status of display audio description for accessible media

Returns:

status of display audio description for accessible media

switchMediaState

void switchMediaState()

switches the status of display audio description for accessible media

isDisplayAlternativeText

boolean isDisplayAlternativeText()

Returns:

true if node can display audio description

playAudioDescription

boolean playAudioDescription()

Returns:

true if can switch to play audio description of the media

switchBackAudioDescription

boolean switchBackAudioDescription()

Returns:

true if can switch back from original node from audio description

getActionOpenDocInDesktop

String getActionOpenDocInDesktop()
                          throws Exception

Throws:

Exception

getPopupContainer

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

Throws:

Exception