net.sourceforge.openutils.mgnlmedia.media.tags.el
Class MediaEl

java.lang.Object
  net.sourceforge.openutils.mgnlmedia.media.tags.el.MediaEl

public final class MediaEl
extends Object

Class that holds media el functions methods

Version:

$Id: MediaEl.java 3621 2011-08-21 17:01:44Z fgiust $

Author:

molaschi

Constructor Summary

MediaEl()
Public constructor.

Method Summary

static String	desc(info.magnolia.cms.core.Content media) Deprecated. use media.getNodeData("description") or ${media.description}
static String	descLoc(info.magnolia.cms.core.Content media, Locale locale) Deprecated.
static String[]	findMediaUsedInWebPages(info.magnolia.cms.core.Content media) Deprecated.
static String	getDescription(info.magnolia.cms.core.Content media) Deprecated.
static String	getDescription(info.magnolia.cms.core.Content media, Locale locale) Deprecated.
static info.magnolia.cms.core.Content	getNode(Object obj) Deprecated.
static String	getPreview(info.magnolia.cms.core.Content media) Deprecated.
protected static info.magnolia.cms.core.Content	getResolutionsNode(info.magnolia.cms.core.Content media) Returns the "resolutions" node, checking for existence
static String	getResolutionUrl(info.magnolia.cms.core.Content media, String resolution) Deprecated.
static int[]	getSize(info.magnolia.cms.core.Content media, String resolution) Deprecated.
static String	getThumbnail(info.magnolia.cms.core.Content media) Deprecated.
static String	getTitle(info.magnolia.cms.core.Content media) Deprecated.
static String	getTitle(info.magnolia.cms.core.Content media, Locale locale) Deprecated.
static String	getType(info.magnolia.cms.core.Content media) Deprecated.
static String	getUrl(info.magnolia.cms.core.Content media) Deprecated.
static String	getUrl2(info.magnolia.cms.core.Content media, Map<String,String> options) Deprecated.
static Integer	height(Object media) Returns the height of the original media, if available.
static String[]	listResolutions(info.magnolia.cms.core.Content media) Deprecated.
static Iterator<info.magnolia.cms.core.Content>	mediaNodesInPlaylist(Object obj) Returns an interator on the playlist content, given the playlist node or UUID.
static MediaModule	module() Get the media module instance
static info.magnolia.cms.core.Content	node(Object obj) Get content node for media
static String	preview(Object mediaref) Get url to media preview
static Object	property(Object mediaref, String property) Returns a property (nodeData) of the media Content.
static String	replaceParam(String param, String newValue) Utility functions used to replace a param in the current URL, Used internally by the crop tag.
static String[]	resolutions(Object mediaref) Get all resolution strings (i.e.
static int[]	size(Object mediaref, String resolution) Get size of an image
static String[]	tags(info.magnolia.cms.core.Content media) Deprecated. use media.getNodeData("tags") or ${media.tags}
static String[]	tagsLoc(info.magnolia.cms.core.Content media, Locale locale) Deprecated.
static String	thumbnail(Object mediaref) Get url to thumbnail
static String	title(info.magnolia.cms.core.Content media) Deprecated. use media.getNodeData("title") or ${media.title}
static String	titleLoc(info.magnolia.cms.core.Content media, Locale locale) Deprecated.
static String	type(Object media) Get media type
static String	url(Object media) Get url for a media
static String	urlParams(Object mediaref, Map<String,String> options) Get url for a media, passing some parameters
static String	urlres(Object mediaref, String resolution) Get url for a resolution
static String[]	usedInWebPages(Object mediaref) Get an array of String(s) containing a list of web pages where this media is used, an empty array otherwise
static Integer	width(Object media) Returns the width of the original media, if available.

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaEl

public MediaEl()

Public constructor. Needed for freemarker support

Method Detail

module

public static MediaModule module()

Get the media module instance

Returns:

media module instance

node

public static info.magnolia.cms.core.Content node(Object obj)

Get content node for media

Parameters:

obj - content node or node UUID or jcr absolute path in media repository

Returns:

content node

url

public static String url(Object media)

Get url for a media

Parameters:

media - media

Returns:

url

urlParams

public static String urlParams(Object mediaref,
                               Map<String,String> options)

Get url for a media, passing some parameters

Parameters:

mediaref - media node or UUID

options - optional parameters

Returns:

url

thumbnail

public static String thumbnail(Object mediaref)

Get url to thumbnail

Parameters:

mediaref - media node or UUID

Returns:

the thumbnail url for this media, null otherwise

type

public static String type(Object media)

Get media type

Parameters:

media - media to get the type

Returns:

the type of this media if existing, null otherwise

resolutions

public static String[] resolutions(Object mediaref)

Get all resolution strings (i.e. 'o200x350;background=45A97B') that generates cached resolutions

Parameters:

mediaref - media node or UUID

Returns:

all resolution strings

urlres

public static String urlres(Object mediaref,
                            String resolution)

Get url for a resolution

Parameters:

mediaref - media node or UUID

resolution - resolution

Returns:

url

size

public static int[] size(Object mediaref,
                         String resolution)

Get size of an image

Parameters:

mediaref - media node or UUID

resolution - resolution for witch calculate size

Returns:

size of an image

preview

public static String preview(Object mediaref)

Get url to media preview

Parameters:

mediaref - media node or UUID

Returns:

the preview url for this media if existing, null otherwise

usedInWebPages

public static String[] usedInWebPages(Object mediaref)

Get an array of String(s) containing a list of web pages where this media is used, an empty array otherwise

Parameters:

mediaref - media node or UUID

Returns:

an array of String(s) containing a list of web pages where this media is used, an empty array otherwise

property

public static Object property(Object mediaref,
                              String property)

Returns a property (nodeData) of the media Content.

Parameters:

mediaref - media node or UUID

property - property name

Returns:

the value of the given nodedata or null if not found

width

public static Integer width(Object media)

Returns the width of the original media, if available.

Parameters:

media - media Content

Returns:

width of the original media, if available

height

public static Integer height(Object media)

Returns the height of the original media, if available.

Parameters:

media - media Content

Returns:

height of the original media, if available

getResolutionsNode

protected static info.magnolia.cms.core.Content getResolutionsNode(info.magnolia.cms.core.Content media)

Returns the "resolutions" node, checking for existence

Parameters:

media -

Returns:

mediaNodesInPlaylist

public static Iterator<info.magnolia.cms.core.Content> mediaNodesInPlaylist(Object obj)

Returns an interator on the playlist content, given the playlist node or UUID. Support both static and dynamic (search based) playlists

Parameters:

obj - playlist node or UUID

Returns:

Iterator of media nodes

replaceParam

public static String replaceParam(String param,
                                  String newValue)

Utility functions used to replace a param in the current URL, Used internally by the crop tag.

Parameters:

param - parm key

newValue - new value

Returns:

new URL

getNode

@Deprecated
public static info.magnolia.cms.core.Content getNode(Object obj)

Deprecated.

getDescription

@Deprecated
public static String getDescription(info.magnolia.cms.core.Content media,
                                               Locale locale)

Deprecated.

getDescription

@Deprecated
public static String getDescription(info.magnolia.cms.core.Content media)

Deprecated.

getTitle

@Deprecated
public static String getTitle(info.magnolia.cms.core.Content media,
                                         Locale locale)

Deprecated.

getTitle

@Deprecated
public static String getTitle(info.magnolia.cms.core.Content media)

Deprecated.

getUrl

@Deprecated
public static String getUrl(info.magnolia.cms.core.Content media)

Deprecated.

getUrl2

@Deprecated
public static String getUrl2(info.magnolia.cms.core.Content media,
                                        Map<String,String> options)

Deprecated.

getResolutionUrl

@Deprecated
public static String getResolutionUrl(info.magnolia.cms.core.Content media,
                                                 String resolution)

Deprecated.

listResolutions

@Deprecated
public static String[] listResolutions(info.magnolia.cms.core.Content media)

Deprecated.

getThumbnail

@Deprecated
public static String getThumbnail(info.magnolia.cms.core.Content media)

Deprecated.

getPreview

@Deprecated
public static String getPreview(info.magnolia.cms.core.Content media)

Deprecated.

getType

@Deprecated
public static String getType(info.magnolia.cms.core.Content media)

Deprecated.

getSize

@Deprecated
public static int[] getSize(info.magnolia.cms.core.Content media,
                                       String resolution)

Deprecated.

findMediaUsedInWebPages

@Deprecated
public static String[] findMediaUsedInWebPages(info.magnolia.cms.core.Content media)

Deprecated.

descLoc

@Deprecated
public static String descLoc(info.magnolia.cms.core.Content media,
                                        Locale locale)

Deprecated.

titleLoc

@Deprecated
public static String titleLoc(info.magnolia.cms.core.Content media,
                                         Locale locale)

Deprecated.

tagsLoc

@Deprecated
public static String[] tagsLoc(info.magnolia.cms.core.Content media,
                                          Locale locale)

Deprecated.

desc

@Deprecated
public static String desc(info.magnolia.cms.core.Content media)

Deprecated. use media.getNodeData("description") or ${media.description}

Get description for a media for the current locale.

Parameters:

media - media

Returns:

description

title

@Deprecated
public static String title(info.magnolia.cms.core.Content media)

Deprecated. use media.getNodeData("title") or ${media.title}

Get title for a media for the current locale.

Parameters:

media - media

Returns:

title

tags

@Deprecated
public static String[] tags(info.magnolia.cms.core.Content media)

Deprecated. use media.getNodeData("tags") or ${media.tags}

Get tags for a media

Parameters:

media - media

Returns:

tags