org.javlo.component.multimedia

Class Multimedia

java.lang.Object

org.javlo.component.core.AbstractVisualComponent

org.javlo.component.meta.DateComponent

org.javlo.component.meta.TimeRangeComponent

org.javlo.component.multimedia.Multimedia

All Implemented Interfaces:

Serializable, Comparable<IContentVisualComponent>, IContentVisualComponent, IDate, IImageTitle, IRestItem, IStaticContainer

Direct Known Subclasses:

PDFMultimedia, VideoContentMultimedia

public class Multimedia
extends TimeRangeComponent
implements IImageTitle, IStaticContainer

standard image component.

exposed variable :

• inherited from AbstractVisualComponent
• String title : the title.
• PaginationContext pagination : pagination context.
• MultimediaResource resources : list of resources to be displayed.

Author:

pvandermaesen

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL
static String	EMBED
static String	IMAGE
protected static String	IMAGE_AFTER_EXEPT_FIRST
protected static String	IMAGE_FIRST
protected static String	NAME_ORDER
protected static String	ORDER_BY_ACCESS
protected static String	RANDOM_ORDER
protected static String	REVERSE_ORDER
static String	SOUND
protected static String	STATIC_EMBED_FOLDER
protected static String	STATIC_IMAGE_FOLDER
protected static String	STATIC_SOUND_FOLDER
protected static String	STATIC_VIDEO_FOLDER
static String	TYPE
static String	VIDEO

Fields inherited from class org.javlo.component.meta.TimeRangeComponent

logger, VALUE_SEPARATOR

Fields inherited from class org.javlo.component.meta.DateComponent

initDate, NOT_VISIBLE_TYPE

Fields inherited from class org.javlo.component.core.AbstractVisualComponent

CACHE_KEY_SUFFIX_PARAM_NAME, COMPONENT_KEY, config, EDIT_CLASS, FORCE_COMPONENT_ID, HIDDEN, I18N_FILE, NOT_EDIT_PREVIEW_PARAM_NAME, SCROLL_TO_COMP_ID_ATTRIBUTE_NAME, TIME_CACHE_NAME

Fields inherited from interface org.javlo.component.image.IImageTitle

NO_LINK

Fields inherited from interface org.javlo.component.core.IContentVisualComponent

COLORED_WRAPPER_CLASS, COMP_ID_REQUEST_PARAM, COMPLEXITY_ADMIN, COMPLEXITY_EASY, COMPLEXITY_STANDARD, CONTAINER_COLOR, DEFAULT_COLOR, DYN_COMP_COLOR, ECOM_COLOR, EDIT_ACTION_CSS_CLASS, GRAPHIC_COLOR, HIGH_LABEL_LEVEL, ID_SEPARATOR, LINK_COLOR, LOW_LABEL_LEVEL, META_COLOR, MIDDLE_LABEL_LEVEL, SEARCH_LEVEL_HIGH, SEARCH_LEVEL_LOW, SEARCH_LEVEL_MIDDLE, SEARCH_LEVEL_NONE, TEXT_COLOR, VIEW_DEFINITION_REQUEST_ID, WEB2_COLOR

Constructor Summary

Constructors

Constructor and Description
Multimedia()

Method Summary

Modifier and Type	Method and Description
protected MultimediaResource	_getFirstResource(ContentContext ctx)
protected boolean	acceptResource(ContentContext ctx, MultimediaResource info)
protected boolean	acceptStaticInfo(ContentContext ctx, StaticInfo info)
boolean	contains(ContentContext ctx, String uri) check if the class contains the static resources define by a URI
protected MultimediaResource	createResource(ContentContext ctx, IVideo video)
protected boolean	displayEmbed(ContentContext ctx)
protected boolean	displayImage(ContentContext ctx)
protected boolean	displaySound(ContentContext ctx)
protected boolean	displayVideo(ContentContext ctx)
Collection<File>	getAllMultimediaFiles(ContentContext ctx)
Collection<Resource>	getAllResources(ContentContext ctx) return all resources found in the component.
Collection<Link>	getAllResourcesLinks(ContentContext ctx) create link to resources.
String	getBaseStaticDir(ContentContext ctx)
int	getComplexityLevel(ContentContext ctx) return the complexity level of the component.
protected List<MultimediaResource>	getContentVideo(ContentContext ctx)
String	getCurrentRootFolder()
protected String	getCurrentRootFolderForBrowse()
String	getDirSelected() get folder with ressources
protected String	getDisplayAsInputName()
protected String	getEditXHTMLCode(ContentContext ctx)
String	getEmptyXHTMLCode(ContentContext ctx) return the code if component contain's no data.
List<File>	getFiles(ContentContext ctx)
String	getFilesDirectory(ContentContext ctx)
protected MultimediaResource	getFirstResource(ContentContext ctx)
String	getFontAwesome()
protected String	getGlobalCssClass()
String	getHexColor() get the exadecimal color for representation of the component.
protected String	getHTMLRelation(ContentContext ctx)
String	getImageDescription(ContentContext ctx)
protected String	getImageFilePath(ContentContext ctx, String fileLink)
protected String	getImageFilter(ContentContext ctx)
String	getImageLinkURL(ContentContext ctx)
String	getImportFolderPath(ContentContext ctx)
String	getInputBaseFolderName()
String	getInputMaxListSizeName()
protected String	getInputNameNameOrder()
protected String	getInputNameOrderByAccess()
protected String	getInputNameRandomOrder()
protected String	getInputNameReverseOrder()
String	getInputPageSizeName()
String	getInputTitle()
protected String	getItemCssClass()
protected String	getLabelTextInputName()
protected Object	getLock(ContentContext ctx)
int	getMaxListSize()
protected String	getMultimediaFilePath(ContentContext ctx, String lg, File file)
protected String	getMultimediaFileURL(ContentContext ctx, File file)
protected String	getMultimediaFileURL(ContentContext ctx, String lg, File file)
protected List<MultimediaResource>	getMultimediaResources(ContentContext ctx)
int	getPageSize()
int	getPopularity(ContentContext ctx) return indice of popularity
protected String	getPreviewFilter(File file)
int	getPriority(ContentContext ctx) return the priority of the picture inside the page (9=max)
protected String	getRelativeFileDirectory(ContentContext ctx)
String	getResourceURL(ContentContext ctx)
protected Collection<String>	getSelection(ContentContext ctx)
String	getSpecialTagTitle(ContentContext ctx)
String	getSpecialTagXHTML(ContentContext ctx)
String[]	getStyleLabelList(ContentContext ctx) return a list of label define the style.
String[]	getStyleList(ContentContext ctx) get the list of style possible for this component.
String	getStyleTitle(ContentContext ctx) return the title of the style choice.
List<String>	getTags()
String	getTitle()
protected String	getTitle(ContentContext ctx)
protected String	getTransformFilter(File file)
String	getType() return the type of the element.
protected ContentContext	getValidVideoCtx(ContentContext ctx, IVideo video)
int	getWordCount(ContentContext ctx) count the word in the content.
protected void	init()
protected void	init(ComponentBean bean, ContentContext ctx)
boolean	initContent(ContentContext ctx) init the content with a default value. sample : "lorem ipsum" for text component.
boolean	isContentCachable(ContentContext ctx) return the part of header needed for this component
boolean	isContentCachableByQuery(ContentContext ctx)
boolean	isContentTimeCachable(ContentContext ctx)
protected boolean	isCountAccess(ContentContext ctx)
protected boolean	isDateRange()
protected boolean	isDisplayOnlyShared()
boolean	isImageValid(ContentContext ctx)
protected boolean	isImported(ContentContext ctx)
boolean	isMirroredByDefault(ContentContext ctx) if this component is duplicated, by default it is mirrored.
boolean	isNameOrder(ContentContext ctx)
protected boolean	isOrder()
boolean	isOrderByAccess(ContentContext ctx)
boolean	isOrderRandom(ContentContext ctx)
boolean	isRealContent(ContentContext ctx) return true if component is considered as realContent and the page that contain the component is also considered as real content.
protected boolean	isRenderInfo(ContentContext ctx)
protected boolean	isRenderLanguage()
boolean	isReverseOrder(ContentContext ctx)
protected boolean	isSelectBrowse()
protected boolean	isTag()
boolean	isUnique() return true if the component must be unique on a page
boolean	isValidDate(ContentContext ctx)
String	performEdit(ContentContext ctx) action call when update the content page.
void	prepareView(ContentContext ctx) prepare the rendering of a component. default attributes put in request : style, value, type, compid
boolean	renameResource(ContentContext ctx, File oldName, File newName) rename a resource
void	setCurrentRootFolder(ContentContext ctx, String folder)
void	setDirSelected(String dir) set folder with resources

Methods inherited from class org.javlo.component.meta.TimeRangeComponent

getDate, getEndDate, getInputEndDateName, getInputStartDateName, getInputTag, getPrefixViewXHTMLCode, getSearchLevel, getStartDate, getSuffixViewXHTMLCode, getViewXHTMLCode

Methods inherited from class org.javlo.component.meta.DateComponent

getDate, getInputDateName, getInputTimeName, renderDate, setDate

Methods inherited from class org.javlo.component.core.AbstractVisualComponent

applyReplacement, cleanValue, clearReplacement, clone, compareTo, contructViewStyle, countLine, delete, deleteMySelf, equals, equals, executeCurrentRenderer, executeJSP, executeRenderer, executeRenderer, extractFieldsFromRenderer, getAjaxId, getArea, getAuthors, getBackgroundColor, getBaseHelpURL, getClassName, getComponentBean, getComponentCSS, getComponentCssClass, getComponentId, getComponentLabel, getComponentPath, getConfig, getConfigMessage, getContainerPage, getContentAsMap, getContentAsText, getContentCache, getContentMessage, getContentName, getContentTimeCache, getCookiesDisplayStatus, getCreationDate, getCSSStyle, getCurrentPage, getCurrentRenderer, getDebugHeader, getDefaultHelpURI, getDefaultRenderer, getDeleteDate, getDescription, getDisplayMessage, getEditorComplexity, getEditText, getEmptyCode, getErrorMessage, getErrorMessage, getExternalResources, getFirstPrefix, getForcedId, getForcedPrefixViewXHTMLCode, getForcedSuffixViewXHTMLCode, getFormName, getHeaderContent, getHelpType, getHelpURI, getHelpURL, getI18nEditableKeys, getId, getImportFolderPath, getInlineStyle, getInputName, getInputNameRenderer, getInputNameRendererTitle, getItalicAndStrongLanguageMarkerList, getJSOnSubmit, getKey, getLabelLevel, getLastSufix, getLayout, getListClass, getListGroup, getListItemTag, getListTag, getMarkerList, getMessage, getMirrorWrapper, getModificationDate, getNextComponent, getPage, getPageDescription, getPreviewAttributes, getPreviewCssClass, getPreviewCssId, getPreviousComponent, getQuotationLanguageMarkerList, getRemplacement, getRenderer, getRendererTitle, getRenderes, getRequestComponent, getSelectRendererXHTML, getSpecialInputTag, getSpecialPreviewCssClass, getSpecialPreviewCssId, getSpecificClass, getStyle, getStyleLabel, getTag, getTextColor, getTextForSearch, getTextLabel, getTextMessage, getTextTitle, getTitleLevel, getTypeInputName, getValue, getValue, getVersion, getViewData, getViewDataFile, getViewID, getViewText, getWidth, getXHTMLCode, getXHTMLConfig, haveRight, includeComponentJSP, includePage, insert, isAjaxWrapper, isAskWidth, isAutoDeletable, isAutoRenderer, isBackgroundColored, isCanAddClass, isColored, isConfig, isDefaultValue, isDispayEmptyXHTMLCode, isDisplayable, isDisplayHidden, isEditOnCreate, isFirstElementOfRepeatSequence, isFirstRepeated, isFreeInputLayout, isHelpURL, isHiddable, isHidden, isHiddenInMode, isInline, isInsertable, isList, isListable, isMetaTitle, isMirrorWrapped, isModify, isNeedDelete, isNeedRefresh, isNeedRenderer, isNew, isNextSame, isNextSame, isNolink, isNoLinkable, isPreviousSame, isPreviousSame, isRepeat, isRepeatable, isRestMatch, isReversedLink, isValueProperties, isValueTranslatable, isViewDataFile, isVisible, isVisible, isVisibleFromCookies, isWrapped, isXML, loadViewData, main, markAsNew, newInstance, next, onStyleChange, performConfig, performUpdate, previous, processView, renderViewXHTMLCode, replaceAllInContent, replaceInContent, resetContentCache, resetViewData, setBackgroundColor, setComponentBean, setContainerPage, setContentCache, setContentTimeCache, setDisplayHidden, setForcedId, setHidden, setHiddenInMode, setList, setMessage, setMirrorWrapped, setModify, setNeedRefresh, setNextComponent, setNolink, setPage, setPreviousComponent, setRenderer, setRepeat, setStyle, setTextColor, setValid, setValue, setWidth, stored, storeViewData, stringToReader, stringToReader, stringToStream, textToXHTML, transflateFrom

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

STATIC_VIDEO_FOLDER

protected static final String STATIC_VIDEO_FOLDER

See Also:

Constant Field Values

STATIC_SOUND_FOLDER

protected static final String STATIC_SOUND_FOLDER

See Also:

Constant Field Values

STATIC_IMAGE_FOLDER

protected static final String STATIC_IMAGE_FOLDER

See Also:

Constant Field Values

STATIC_EMBED_FOLDER

protected static final String STATIC_EMBED_FOLDER

See Also:

Constant Field Values

IMAGE_FIRST

protected static final String IMAGE_FIRST

See Also:

Constant Field Values

IMAGE_AFTER_EXEPT_FIRST

protected static final String IMAGE_AFTER_EXEPT_FIRST

See Also:

Constant Field Values

ORDER_BY_ACCESS

protected static final String ORDER_BY_ACCESS

See Also:

Constant Field Values

REVERSE_ORDER

protected static final String REVERSE_ORDER

See Also:

Constant Field Values

NAME_ORDER

protected static final String NAME_ORDER

See Also:

Constant Field Values

RANDOM_ORDER

protected static final String RANDOM_ORDER

See Also:

Constant Field Values

ALL

public static final String ALL

See Also:

Constant Field Values

IMAGE

public static final String IMAGE

See Also:

Constant Field Values

SOUND

public static final String SOUND

See Also:

Constant Field Values

VIDEO

public static final String VIDEO

See Also:

Constant Field Values

EMBED

public static final String EMBED

See Also:

Constant Field Values

Constructor Detail

Multimedia

public Multimedia()

Method Detail

acceptStaticInfo

protected boolean acceptStaticInfo(ContentContext ctx,
                                   StaticInfo info)

acceptResource

protected boolean acceptResource(ContentContext ctx,
                                 MultimediaResource info)

displayEmbed

protected boolean displayEmbed(ContentContext ctx)

displayImage

protected boolean displayImage(ContentContext ctx)

displaySound

protected boolean displaySound(ContentContext ctx)

displayVideo

protected boolean displayVideo(ContentContext ctx)

isRealContent

public boolean isRealContent(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return true if component is considered as realContent and the page that contain the component is also considered as real content.

Specified by:

isRealContent in interface IContentVisualComponent

Overrides:

isRealContent in class DateComponent

Parameters:

ctx - current context

Returns:

getImageFilter

protected String getImageFilter(ContentContext ctx)

getValidVideoCtx

protected ContentContext getValidVideoCtx(ContentContext ctx,
                                          IVideo video)

createResource

protected MultimediaResource createResource(ContentContext ctx,
                                            IVideo video)

getContentVideo

protected List<MultimediaResource> getContentVideo(ContentContext ctx)
                                            throws Exception

Throws:

Exception

getAllMultimediaFiles

public Collection<File> getAllMultimediaFiles(ContentContext ctx)

getBaseStaticDir

public String getBaseStaticDir(ContentContext ctx)

getCurrentRootFolder

public String getCurrentRootFolder()

setCurrentRootFolder

public void setCurrentRootFolder(ContentContext ctx,
                                 String folder)

getDisplayAsInputName

protected String getDisplayAsInputName()

Overrides:

getDisplayAsInputName in class AbstractVisualComponent

getSelection

protected Collection<String> getSelection(ContentContext ctx)

isDateRange

protected boolean isDateRange()

isOrder

protected boolean isOrder()

isTag

protected boolean isTag()

getCurrentRootFolderForBrowse

protected String getCurrentRootFolderForBrowse()

isSelectBrowse

protected boolean isSelectBrowse()

getEditXHTMLCode

protected String getEditXHTMLCode(ContentContext ctx)
                           throws Exception

Overrides:

getEditXHTMLCode in class TimeRangeComponent

Throws:

Exception

getFilesDirectory

public String getFilesDirectory(ContentContext ctx)

getGlobalCssClass

protected String getGlobalCssClass()

getHexColor

public String getHexColor()

Description copied from interface: IContentVisualComponent

get the exadecimal color for representation of the component.

Specified by:

getHexColor in interface IContentVisualComponent

Overrides:

getHexColor in class TimeRangeComponent

Returns:

a exadecimal color (sample : a5b499)

getHTMLRelation

protected String getHTMLRelation(ContentContext ctx)

getImageFilePath

protected String getImageFilePath(ContentContext ctx,
                                  String fileLink)

getInputBaseFolderName

public String getInputBaseFolderName()

getInputMaxListSizeName

public String getInputMaxListSizeName()

getInputPageSizeName

public String getInputPageSizeName()

getInputTitle

public String getInputTitle()

getInputNameOrderByAccess

protected String getInputNameOrderByAccess()

getInputNameRandomOrder

protected String getInputNameRandomOrder()

getInputNameReverseOrder

protected String getInputNameReverseOrder()

getInputNameNameOrder

protected String getInputNameNameOrder()

getItemCssClass

protected String getItemCssClass()

getMaxListSize

public int getMaxListSize()

getPageSize

public int getPageSize()

getTags

public List<String> getTags()

getTitle

public String getTitle()

getMultimediaFilePath

protected String getMultimediaFilePath(ContentContext ctx,
                                       String lg,
                                       File file)

getMultimediaFileURL

protected String getMultimediaFileURL(ContentContext ctx,
                                      File file)

getMultimediaFileURL

protected String getMultimediaFileURL(ContentContext ctx,
                                      String lg,
                                      File file)

getPreviewFilter

protected String getPreviewFilter(File file)

getRelativeFileDirectory

protected String getRelativeFileDirectory(ContentContext ctx)

getStyleLabelList

public String[] getStyleLabelList(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return a list of label define the style.

Specified by:

getStyleLabelList in interface IContentVisualComponent

Overrides:

getStyleLabelList in class DateComponent

Returns:

a list of label.

getStyleList

public String[] getStyleList(ContentContext ctx)

Description copied from interface: IContentVisualComponent

get the list of style possible for this component.

Specified by:

getStyleList in interface IContentVisualComponent

Overrides:

getStyleList in class DateComponent

Returns:

a list of string represent a style.

getStyleTitle

public String getStyleTitle(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return the title of the style choice.

Specified by:

getStyleTitle in interface IContentVisualComponent

Overrides:

getStyleTitle in class DateComponent

getTitle

protected String getTitle(ContentContext ctx)

getTransformFilter

protected String getTransformFilter(File file)

getType

public String getType()

Description copied from interface: IContentVisualComponent

return the type of the element.

Specified by:

getType in interface IContentVisualComponent

Overrides:

getType in class TimeRangeComponent

Returns:

the type of the element.

getFirstResource

protected MultimediaResource getFirstResource(ContentContext ctx)
                                       throws Exception

Throws:

Exception

_getFirstResource

protected MultimediaResource _getFirstResource(ContentContext ctx)
                                        throws Exception

Throws:

Exception

getMultimediaResources

protected List<MultimediaResource> getMultimediaResources(ContentContext ctx)
                                                   throws Exception

Throws:

Exception

prepareView

public void prepareView(ContentContext ctx)
                 throws Exception

Description copied from class: AbstractVisualComponent

prepare the rendering of a component. default attributes put in request : style, value, type, compid

Overrides:

prepareView in class TimeRangeComponent

Throws:

Exception

getWordCount

public int getWordCount(ContentContext ctx)

Description copied from interface: IContentVisualComponent

count the word in the content.

Specified by:

getWordCount in interface IContentVisualComponent

Overrides:

getWordCount in class AbstractVisualComponent

Returns:

init

protected void init()
             throws ResourceNotFoundException

Overrides:

init in class TimeRangeComponent

Throws:

ResourceNotFoundException

isImported

protected boolean isImported(ContentContext ctx)

init

protected void init(ComponentBean bean,
                    ContentContext ctx)
             throws Exception

Overrides:

init in class AbstractVisualComponent

Throws:

Exception

getImportFolderPath

public String getImportFolderPath(ContentContext ctx)
                           throws Exception

Overrides:

getImportFolderPath in class AbstractVisualComponent

Throws:

Exception

isContentCachable

public boolean isContentCachable(ContentContext ctx)

Description copied from interface: IContentVisualComponent

return the part of header needed for this component

Specified by:

isContentCachable in interface IContentVisualComponent

Overrides:

isContentCachable in class DateComponent

Returns:

isContentTimeCachable

public boolean isContentTimeCachable(ContentContext ctx)

Overrides:

isContentTimeCachable in class AbstractVisualComponent

isContentCachableByQuery

public boolean isContentCachableByQuery(ContentContext ctx)

Overrides:

isContentCachableByQuery in class AbstractVisualComponent

isCountAccess

protected boolean isCountAccess(ContentContext ctx)

isDisplayOnlyShared

protected boolean isDisplayOnlyShared()