Package com.jalios.jcms.document.editor

Class ImageDocumentEditor

java.lang.Object

com.jalios.jcms.document.editor.AbstractDocumentEditor

com.jalios.jcms.document.editor.ImageDocumentEditor

All Implemented Interfaces:

DocumentEditor

public class ImageDocumentEditor
extends AbstractDocumentEditor

Constructor Summary

Constructors

Constructor	Description
ImageDocumentEditor()

Method Summary

Modifier and Type	Method	Description
boolean	accept(FileDocument doc, Member mbr)	Returns true if the editor accepts the member to edit the document.
java.lang.String	getButtonLabel(java.lang.String lang, FileDocument doc, Member mbr)	Return the localized label used for the button (if only this editor is available).
java.lang.String	getIcon(FileDocument doc, Member mbr)	Returns the 16x16-sized icon of the editor (icon property name without the icon.
java.lang.String	getLinkAttributes(java.lang.String lang, FileDocument doc, Member mbr)	Returns HTML attributes to add to the link.
java.lang.String	getLinkCss()	Returns CSS classes to add to the link.
java.lang.String	getName(java.lang.String lang)	Returns the localized name of the editor.
java.lang.String	getUrl(FileDocument doc, Member mbr, java.lang.String baseUrl)	Returns the URL to open the document.

Methods inherited from class com.jalios.jcms.document.editor.AbstractDocumentEditor

getKey, setKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jalios.jcms.document.editor.DocumentEditor

getIcon48, getLinkAttributes, getMenuLabel, getUrl

Constructor Detail

ImageDocumentEditor

public ImageDocumentEditor()

Method Detail

accept

public boolean accept(FileDocument doc,
                      Member mbr)

Description copied from interface: DocumentEditor

Returns true if the editor accepts the member to edit the document.

Parameters:

doc - the document

mbr - the member

Returns:

true if the editor accepts the member to edit the document.

getUrl

public java.lang.String getUrl(FileDocument doc,
                               Member mbr,
                               java.lang.String baseUrl)

Description copied from interface: DocumentEditor

Returns the URL to open the document.

Parameters:

doc - the document

mbr - the member

baseUrl - the base URL of the site

Returns:

the URL to edit the document.

getName

public java.lang.String getName(java.lang.String lang)

Description copied from interface: DocumentEditor

Returns the localized name of the editor.

Parameters:

lang - the language

Returns:

the localized name of the editor.

getIcon

public java.lang.String getIcon(FileDocument doc,
                                Member mbr)

Description copied from interface: DocumentEditor

Returns the 16x16-sized icon of the editor (icon property name without the icon. prefix).

Parameters:

doc - the document

mbr - the document

Returns:

the icon of the editor.

getButtonLabel

public java.lang.String getButtonLabel(java.lang.String lang,
                                       FileDocument doc,
                                       Member mbr)

Description copied from interface: DocumentEditor

Return the localized label used for the button (if only this editor is available).

Parameters:

lang - the language

doc - the document

mbr - the document

Returns:

the localized label used for the button (if only this editor is available).

getLinkCss

public java.lang.String getLinkCss()

Description copied from interface: DocumentEditor

Returns CSS classes to add to the link.

Returns:

CSS classes to add to the link.

getLinkAttributes

public java.lang.String getLinkAttributes(java.lang.String lang,
                                          FileDocument doc,
                                          Member mbr)

Description copied from interface: DocumentEditor

Returns HTML attributes to add to the link.

Parameters:

lang - the language

doc - the document

mbr - the document

Returns:

HTML attributes to add to the link.