com.jalios.jcms.media

Class MediaBrowserHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.media.MediaBrowserHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class MediaBrowserHandler
extends JcmsJspContext

This handler controls the MediaBrowser.

Since:

jcms-5.5.0

Version:

$Revision: 74925 $

Author:

Olivier Jaquemet

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	catMode
protected java.lang.String[]	cids
protected java.lang.String	currentMedia
protected java.util.ArrayList<java.lang.String>	mediaList
protected QueryHandler	queryHandler
protected QueryResultSet	resultSet
static java.lang.String	REVISION
protected boolean	sortReverse
protected java.lang.String	sortType
protected int	start
protected static java.util.ArrayList<java.lang.String>	staticMediaList
protected java.lang.String	text
protected boolean	workspaceFilter
protected java.util.ArrayList<Workspace>	workspaceList

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors

Constructor and Description
MediaBrowserHandler() Bean constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	computeFileDocumentSet() Compute the FileDocument result set to display in this media browser using the option already given.
java.util.Set<Category>	getCategorySet() Retrieve the current categories used for refinement in this media browser.
java.lang.String	getCatMode() Retrieve the current mode used for category refinement in this media browser.
java.lang.String	getCurrentMedia() Retrieve the current media name displayed by this media browser.
static java.lang.String	getMedia(QueryHandler qh) Retrieve the media selected in the specified MediaBrowser's query.
java.util.ArrayList<java.lang.String>	getMediaList() Retrieve the media list the media browser should display, as declared using property "media-browser.media-list".
java.lang.String	getMediaURL(java.lang.String media) Retrieve an url that can be used to display this media browser using a new media (the given one).
java.lang.String	getMediaURL(java.lang.String media, boolean escapeAmpersand) Retrieve an url that can be used to display this media browser using a new media (the given one).
QueryResultSet	getResultSet() Retrieve the QueryResultSet of FileDocument we are currently working on.
java.lang.String	getText() Retrieve the current text used for refinement in this media browser.
java.util.Set<java.lang.Class<? extends FileDocument>>	getTypeSet() Returns the Set of document type that can used in the given workspace by the given member.
java.util.ArrayList<Workspace>	getWorkspaceList() Retrieve the workspace list in which the logged member can work.
boolean	isCurrentMedia(java.lang.String media) Check if the given media is the same as the current one displayed by this media browser.
static boolean	isMediaBrowserQuery(QueryHandler qh) Check if the specified QueryHandler is a MediaBrowser's query.
boolean	isWorkspaceFilter() Check if workspace filter is enabled or not.
static void	reloadProperties()
void	setCatMode(java.lang.String catMode) Set the mode to use when dealing with categories refinement in this MediaBrowser
void	setCids(java.lang.String[] cids) Set the categories id used to refine FileDocument displayed in this MediaBrowser
void	setMedia(java.lang.String media) Set the media to display for this MediaBrowser.
void	setMedias(java.lang.String[] medias) Set the medias authorized to be viewed for this MediaBrowser
void	setReverse(boolean reverse)
void	setSort(java.lang.String sort)
void	setStart(int start)
void	setText(java.lang.String text) Set the text to use to refine FileDocument displayed in this MediaBrowser
void	setWorkspaceFilter(boolean workspaceFilter) Set whether to refine using current workspace or not.
boolean	validate()

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, addMsg, addMsg, addMsgSession, addMsgSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, getWorkspace, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, retrieveUploadedFile, select, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

staticMediaList

protected static java.util.ArrayList<java.lang.String> staticMediaList

mediaList

protected java.util.ArrayList<java.lang.String> mediaList

currentMedia

protected java.lang.String currentMedia

workspaceList

protected java.util.ArrayList<Workspace> workspaceList

catMode

protected java.lang.String catMode

cids

protected java.lang.String[] cids

text

protected java.lang.String text

workspaceFilter

protected boolean workspaceFilter

queryHandler

protected QueryHandler queryHandler

resultSet

protected QueryResultSet resultSet

start

protected int start

sortType

protected java.lang.String sortType

sortReverse

protected boolean sortReverse

Constructor Detail

MediaBrowserHandler

public MediaBrowserHandler()

Bean constructor.

Method Detail

reloadProperties

public static void reloadProperties()

validate

public boolean validate()
                 throws java.io.IOException

Throws:

java.io.IOException

computeFileDocumentSet

public void computeFileDocumentSet()

Compute the FileDocument result set to display in this media browser using the option already given.

getMediaList

public java.util.ArrayList<java.lang.String> getMediaList()

Retrieve the media list the media browser should display, as declared using property "media-browser.media-list".
"all", "images", "videos", "sounds", "others".

Returns:

an ArrayList of String.

getCurrentMedia

public java.lang.String getCurrentMedia()

Retrieve the current media name displayed by this media browser.

Returns:

a String represeting the name of the media "all", "images".

See Also:

getMediaList()

isCurrentMedia

public boolean isCurrentMedia(java.lang.String media)

Check if the given media is the same as the current one displayed by this media browser.

Parameters:

media - the media to check

Returns:

true if they are the same, false otherwise.

getMediaURL

public java.lang.String getMediaURL(java.lang.String media)

Retrieve an url that can be used to display this media browser using a new media (the given one).

Parameters:

media - the new media to use

Returns:

an URL (with any parameters seperated with ampersand entity for use in HTML a href)

getMediaURL

public java.lang.String getMediaURL(java.lang.String media,
                           boolean escapeAmpersand)

Retrieve an url that can be used to display this media browser using a new media (the given one).

Parameters:

media - the new media to use

escapeAmpersand - will use "&" if true, "&" if false

Returns:

an URL.

Since:

jcms-9.0.0

getWorkspaceList

public java.util.ArrayList<Workspace> getWorkspaceList()

Retrieve the workspace list in which the logged member can work.

Returns:

an ArrayList of Workspace

getCatMode

public java.lang.String getCatMode()

Retrieve the current mode used for category refinement in this media browser.

Returns:

a String.

getCategorySet

public java.util.Set<Category> getCategorySet()

Retrieve the current categories used for refinement in this media browser.

Returns:

a Set of Category.

getText

public java.lang.String getText()

Retrieve the current text used for refinement in this media browser.

Returns:

a String.

isWorkspaceFilter

public boolean isWorkspaceFilter()

Check if workspace filter is enabled or not.

Returns:

true if it is enabled, false otherwise.

getResultSet

public QueryResultSet getResultSet()

Retrieve the QueryResultSet of FileDocument we are currently working on.

Returns:

a QueryResultSet of FileDocument (not sorted)

getTypeSet

public java.util.Set<java.lang.Class<? extends FileDocument>> getTypeSet()

Returns the Set of document type that can used in the given workspace by the given member.

Returns:

the Set of document type that can used in the given workspace by the given member.

Since:

jcms-9.0.0

setMedias

public void setMedias(java.lang.String[] medias)

Set the medias authorized to be viewed for this MediaBrowser

Parameters:

medias - an array of medias (from "all", "image", "video" and "audio")

setMedia

public void setMedia(java.lang.String media)

Set the media to display for this MediaBrowser.

Parameters:

media - a media (from "all","image","video" or "audio")

setCatMode

public void setCatMode(java.lang.String catMode)

Set the mode to use when dealing with categories refinement in this MediaBrowser

Parameters:

catMode - the cat mode ("or" or "and")

See Also:

QueryHandler.setCatMode(String)

setCids

public void setCids(java.lang.String[] cids)

Set the categories id used to refine FileDocument displayed in this MediaBrowser

Parameters:

cids - the category ids

setText

public void setText(java.lang.String text)

Set the text to use to refine FileDocument displayed in this MediaBrowser

Parameters:

text - the text to search

setWorkspaceFilter

public void setWorkspaceFilter(boolean workspaceFilter)

Set whether to refine using current workspace or not.

Parameters:

workspaceFilter - true to refine, false to use all workspace

setStart

public void setStart(int start)

setSort

public void setSort(java.lang.String sort)

setReverse

public void setReverse(boolean reverse)

isMediaBrowserQuery

public static boolean isMediaBrowserQuery(QueryHandler qh)

Check if the specified QueryHandler is a MediaBrowser's query.
In the current implementation, it indicates that this query has been processed through MediaBrowserHandler.java in "work/mediaBrowser.jsp".

Parameters:

qh - the QueryHandler to check

Returns:

true if the query being filtered is a MediaBrowser's query, false for any other query.

Since:

jcms-7.0.0

getMedia

public static java.lang.String getMedia(QueryHandler qh)

Retrieve the media selected in the specified MediaBrowser's query.
The media is a string taken from coma seperated value specified in property "media-browser.media-list"

Parameters:

qh - the QueryHandler to check

Returns:

the media String selected in the media browser or null if the specified query is not a MediaBrowser's query

Since:

jcms-7.0.0