org.opencms.jsp

类 CmsJspTagImage

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

org.opencms.jsp.CmsJspTagImage

所有已实现的接口:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, I_CmsJspTagParamParent

public class CmsJspTagImage
extends javax.servlet.jsp.tagext.BodyTagSupport
implements I_CmsJspTagParamParent

Creates HTML code for <img src> tags that use the OpenCms image scaling capabilities.

从以下版本开始:

6.2.0

另请参阅:

序列化表格

字段概要

从类继承的字段 javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

从类继承的字段 javax.servlet.jsp.tagext.TagSupport

id, pageContext

从接口继承的字段 javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

从接口继承的字段 javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

从接口继承的字段 javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

构造器概要

构造器

构造器和说明
CmsJspTagImage() Creates a new image scaling tag instance.

方法概要

方法

限定符和类型	方法和说明
void	addParameter(java.lang.String name, java.lang.String value) Add a parameter to this tag.
int	doEndTag()
int	doStartTag() Returns BodyTag.EVAL_BODY_BUFFERED.
java.lang.String	getAlign() Returns the value of the HTML "align" attribute.
java.lang.String	getAlt() Returns the value of the HTML "alt" attribute.
java.lang.String	getBorder() Returns the value of the HTML "border" attribute.
java.lang.String	getCssclass() Returns the value of the HTML "class" attribute.
java.lang.String	getHeight() Returns the scaling height for the image.
java.lang.String	getHspace() Returns the value of the HTML "hspace" attribute.
java.lang.String	getId() Returns the value of the HTML "id" attribute.
java.lang.String	getLongdesc() Returns the value of the HTML "longdesc" attribute.
java.lang.String	getMaxHeight() Returns the maximum scaling height for the image, only needed if scale type is 5.
java.lang.String	getMaxWidth() Returns the maximum scaling width for the image, only needed if scale type is 5.
java.lang.String	getName() Returns the value of the HTML "name" attribute.
java.lang.String	getNoDim() Returns "true" if the created HTML image tag does not contain height and width attributes.
java.lang.String	getScaleColor() Returns the background color used by the image scaler.
java.lang.String	getScaleFilter() Returns the filter list used by the image scaler.
java.lang.String	getScalePosition() Returns the position used by the image scaler.
java.lang.String	getScaleQuality() Returns the quality used by the image scaler.
static CmsImageScaler	getScaler(CmsImageScaler scaler, CmsImageScaler original, java.lang.String scaleParam) Creates the images scaler used by this image tag.
java.lang.String	getScaleRendermode() Returns the render mode used by the image scaler.
java.lang.String	getScaleType() Returns the scaling type for the image.
java.lang.String	getSrc() Returns the source of the image to scale, which will have the OpenCms webapp / servlet prefix added.
java.lang.String	getStyle() Returns the value of the HTML "style" attribute.
java.lang.String	getTitle() Returns the value of the HTML "title" attribute.
java.lang.String	getUsemap() Returns the value of the HTML "usemap" attribute.
java.lang.String	getVspace() Returns the value of the HTML "vspace" attribute.
java.lang.String	getWidth() Returns the scaling width for the image.
static java.lang.String	imageTagAction(java.lang.String src, CmsImageScaler scaler, java.util.Map<java.lang.String,java.lang.String> attributes, boolean partialTag, boolean noDim, javax.servlet.ServletRequest req) Internal action method to create the tag content.
static java.lang.String	imageTagAction(java.lang.String src, CmsImageScaler scaler, java.util.Map<java.lang.String,java.lang.String> attributes, boolean partialTag, javax.servlet.ServletRequest req) Internal action method to create the tag content.
java.lang.String	isPartialTag() Returns "true" if the HTML tag should only be created as partial tag.
void	release()
void	setAlign(java.lang.String value) Sets the value of the HTML "align" attribute.
void	setAlt(java.lang.String value) Sets the value of the HTML "alt" attribute.
void	setBorder(java.lang.String value) Sets the value of the HTML "border" attribute.
void	setCssclass(java.lang.String value) Sets the value of the HTML "class" attribute.
void	setHeight(java.lang.String value) Sets the scaling height for the image.
void	setHspace(java.lang.String value) Sets the value of the HTML "hspace" attribute.
void	setId(java.lang.String value) Sets the value of the HTML "id" attribute.
void	setLongdesc(java.lang.String value) Sets the value of the HTML "longdesc" attribute.
void	setMaxHeight(java.lang.String value) Sets the maximum scaling height for the image, only needed if scale type is 5.
void	setMaxWidth(java.lang.String value) Sets the maximum scaling width for the image, only needed if scale type is 5.
void	setName(java.lang.String value) Sets the value of the HTML "name" attribute.
void	setNoDim(java.lang.String noDim) Controls if the created HTML image tag contains height and width attributes.
void	setPartialTag(java.lang.String partialTag) Controls if the created HTML image tag is a full or partial tag.
void	setScaleColor(java.lang.String value) Sets the background color used by the image scaler.
void	setScaleFilter(java.lang.String value) Sets the filter(s) used by the image scaler.
void	setScalePosition(java.lang.String value) Sets the position used by the image scaler.
void	setScaleQuality(java.lang.String value) Sets the quality used by the image scaler.
void	setScaleRendermode(java.lang.String value) Sets the render mode used by the image scaler.
void	setScaleType(java.lang.String value) Sets the scaling type for the image.
void	setSrc(java.lang.String value) Sets the source of the image.
void	setStyle(java.lang.String value) Sets the value of the HTML "style" attribute.
void	setTitle(java.lang.String value) Sets the value of the HTML "title" attribute.
void	setUsemap(java.lang.String value) Sets the value of the HTML "usemap" attribute.
void	setVspace(java.lang.String value) Sets the value of the HTML "vspace" attribute.
void	setWidth(java.lang.String value) Sets the scaling width for the image.

从类继承的方法 javax.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

从类继承的方法 javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue

从类继承的方法 java.lang.Object

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

从接口继承的方法 javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

构造器详细资料

CmsJspTagImage

public CmsJspTagImage()

Creates a new image scaling tag instance.

方法详细资料

getScaler

public static CmsImageScaler getScaler(CmsImageScaler scaler,
                       CmsImageScaler original,
                       java.lang.String scaleParam)

Creates the images scaler used by this image tag.

参数:

scaler - the scaler created from this tags parameters

original - a scaler that contains the original image dimensions

scaleParam - optional scaler parameters for cropping

返回:

the images scaler used by this image tag

imageTagAction

public static java.lang.String imageTagAction(java.lang.String src,
                              CmsImageScaler scaler,
                              java.util.Map<java.lang.String,java.lang.String> attributes,
                              boolean partialTag,
                              boolean noDim,
                              javax.servlet.ServletRequest req)
                                       throws CmsException

Internal action method to create the tag content.

参数:

src - the image source

scaler - the image scaleing parameters

attributes - the additional image HTML attributes

partialTag - if true, the opening <img and closing /> is omitted

noDim - if true, the height and width attributes are omitted

req - the current request

返回:

the created <img src> tag content

抛出:

CmsException - in case something goes wrong

imageTagAction

public static java.lang.String imageTagAction(java.lang.String src,
                              CmsImageScaler scaler,
                              java.util.Map<java.lang.String,java.lang.String> attributes,
                              boolean partialTag,
                              javax.servlet.ServletRequest req)
                                       throws CmsException

Internal action method to create the tag content.

参数:

src - the image source

scaler - the image scaleing parameters

attributes - the additional image HTML attributes

partialTag - if true, the opening <img and closing /> is omitted

req - the current request

返回:

the created <img src> tag content

抛出:

CmsException - in case something goes wrong

addParameter

public void addParameter(java.lang.String name,
                java.lang.String value)

从接口复制的说明: I_CmsJspTagParamParent

Add a parameter to this tag. The intent is that the <param> subtag will call this to register parameters. Assumes that 'name' and 'value' are appropriately encoded and do not contain any meaningful metacharacters; in order words, escaping is the responsibility of the caller.

指定者:

addParameter 在接口中 I_CmsJspTagParamParent

参数:

name - the name of the parameter

value - the value of the parameter

另请参阅:

I_CmsJspTagParamParent.addParameter(java.lang.String, java.lang.String)

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

指定者:

doEndTag 在接口中 javax.servlet.jsp.tagext.Tag

覆盖:

doEndTag 在类中 javax.servlet.jsp.tagext.BodyTagSupport

抛出:

javax.servlet.jsp.JspException

另请参阅:

Tag.doEndTag()

doStartTag

public int doStartTag()

Returns BodyTag.EVAL_BODY_BUFFERED.

指定者:

doStartTag 在接口中 javax.servlet.jsp.tagext.Tag

覆盖:

doStartTag 在类中 javax.servlet.jsp.tagext.BodyTagSupport

返回:

BodyTag.EVAL_BODY_BUFFERED

另请参阅:

Tag.doStartTag()

getAlign

public java.lang.String getAlign()

Returns the value of the HTML "align" attribute.

返回:

the value of the HTML "align" attribute

getAlt

public java.lang.String getAlt()

Returns the value of the HTML "alt" attribute.

返回:

the value of the HTML "alt" attribute

getBorder

public java.lang.String getBorder()

Returns the value of the HTML "border" attribute.

返回:

the value of the HTML "border" attribute

getCssclass

public java.lang.String getCssclass()

Returns the value of the HTML "class" attribute.

返回:

the value of the HTML "class" attribute

getHeight

public java.lang.String getHeight()

Returns the scaling height for the image.

返回:

the scaling height for the image

getHspace

public java.lang.String getHspace()

Returns the value of the HTML "hspace" attribute.

返回:

the value of the HTML "hspace" attribute

getId

public java.lang.String getId()

Returns the value of the HTML "id" attribute.

覆盖:

getId 在类中 javax.servlet.jsp.tagext.TagSupport

返回:

the value of the HTML "id" attribute

getLongdesc

public java.lang.String getLongdesc()

Returns the value of the HTML "longdesc" attribute.

返回:

the value of the HTML "longdesc" attribute

getMaxHeight

public java.lang.String getMaxHeight()

Returns the maximum scaling height for the image, only needed if scale type is 5.

返回:

the maximum scaling height for the image

getMaxWidth

public java.lang.String getMaxWidth()

Returns the maximum scaling width for the image, only needed if scale type is 5.

返回:

the maximum scaling width for the image

getName

public java.lang.String getName()

Returns the value of the HTML "name" attribute.

返回:

the value of the HTML "name" attribute

getNoDim

public java.lang.String getNoDim()

Returns "true" if the created HTML image tag does not contain height and width attributes.

返回:

"true" if the created HTML image tag does not contain height and width attributes

getScaleColor

public java.lang.String getScaleColor()

Returns the background color used by the image scaler.

返回:

the background color used by the image scaler

getScaleFilter

public java.lang.String getScaleFilter()

Returns the filter list used by the image scaler.

返回:

the filter list used by the image scaler

getScalePosition

public java.lang.String getScalePosition()

Returns the position used by the image scaler.

返回:

the position used by the image scaler

getScaleQuality

public java.lang.String getScaleQuality()

Returns the quality used by the image scaler.

返回:

the quality used by the image scaler

getScaleRendermode

public java.lang.String getScaleRendermode()

Returns the render mode used by the image scaler.

返回:

the render mode used by the image scaler

getScaleType

public java.lang.String getScaleType()

Returns the scaling type for the image.

返回:

the scaling type for the image

getSrc

public java.lang.String getSrc()

Returns the source of the image to scale, which will have the OpenCms webapp / servlet prefix added.

返回:

the source of the image to scale

getStyle

public java.lang.String getStyle()

Returns the value of the HTML "style" attribute.

返回:

the value of the HTML "style" attribute

getTitle

public java.lang.String getTitle()

Returns the value of the HTML "title" attribute.

返回:

the value of the HTML "title" attribute

getUsemap

public java.lang.String getUsemap()

Returns the value of the HTML "usemap" attribute.

返回:

the value of the HTML "usemap" attribute

getVspace

public java.lang.String getVspace()

Returns the value of the HTML "vspace" attribute.

返回:

the value of the HTML "vspace" attribute

getWidth

public java.lang.String getWidth()

Returns the scaling width for the image.

返回:

the scaling width for the image

isPartialTag

public java.lang.String isPartialTag()

Returns "true" if the HTML tag should only be created as partial tag.

返回:

"true" if the HTML tag should only be created as partial tag

release

public void release()

指定者:

release 在接口中 javax.servlet.jsp.tagext.Tag

覆盖:

release 在类中 javax.servlet.jsp.tagext.BodyTagSupport

另请参阅:

Tag.release()

setAlign

public void setAlign(java.lang.String value)

Sets the value of the HTML "align" attribute.

参数:

value - the value of the HTML "align" attribute to set

setAlt

public void setAlt(java.lang.String value)

Sets the value of the HTML "alt" attribute.

参数:

value - the value of the HTML "alt" attribute to set

setBorder

public void setBorder(java.lang.String value)

Sets the value of the HTML "border" attribute.

参数:

value - the value of the HTML "border" attribute to set

setCssclass

public void setCssclass(java.lang.String value)

Sets the value of the HTML "class" attribute.

参数:

value - the value of the HTML "class" attribute to set

setHeight

public void setHeight(java.lang.String value)

Sets the scaling height for the image.

If no valid integer is given, then "0" is used as value.

参数:

value - the scaling height for the image to set

setHspace

public void setHspace(java.lang.String value)

Sets the value of the HTML "hspace" attribute.

参数:

value - the value of the HTML "hspace" attribute to set

setId

public void setId(java.lang.String value)

Sets the value of the HTML "id" attribute.

覆盖:

setId 在类中 javax.servlet.jsp.tagext.TagSupport

参数:

value - the value of the HTML "id" attribute to set

setLongdesc

public void setLongdesc(java.lang.String value)

Sets the value of the HTML "longdesc" attribute.

参数:

value - the value of the HTML "longdesc" attribute to set

setMaxHeight

public void setMaxHeight(java.lang.String value)

Sets the maximum scaling height for the image, only needed if scale type is 5.

If no valid integer is given, then the value of getHeight() is used as value.

参数:

value - the maximum scaling height for the image to set

setMaxWidth

public void setMaxWidth(java.lang.String value)

Sets the maximum scaling width for the image, only needed if scale type is 5.

If no valid integer is given, then the value of getWidth() is used as value.

参数:

value - the maximum scaling width for the image to set

setName

public void setName(java.lang.String value)

Sets the value of the HTML "name" attribute.

参数:

value - the value of the HTML "name" attribute to set

setNoDim

public void setNoDim(java.lang.String noDim)

Controls if the created HTML image tag contains height and width attributes.

参数:

noDim - the value to set

setPartialTag

public void setPartialTag(java.lang.String partialTag)

Controls if the created HTML image tag is a full or partial tag.

参数:

partialTag - the value to set

setScaleColor

public void setScaleColor(java.lang.String value)

Sets the background color used by the image scaler.

参数:

value - the background color to set

setScaleFilter

public void setScaleFilter(java.lang.String value)

Sets the filter(s) used by the image scaler.

参数:

value - the filter(s) to set

setScalePosition

public void setScalePosition(java.lang.String value)

Sets the position used by the image scaler.

参数:

value - the position to set

setScaleQuality

public void setScaleQuality(java.lang.String value)

Sets the quality used by the image scaler.

参数:

value - the quality to set

setScaleRendermode

public void setScaleRendermode(java.lang.String value)

Sets the render mode used by the image scaler.

参数:

value - the render mode to set

setScaleType

public void setScaleType(java.lang.String value)

Sets the scaling type for the image.

If no valid integer is given, then "0" is used as value.

参数:

value - the scaling type for the image to set

setSrc

public void setSrc(java.lang.String value)

Sets the source of the image.

The source must be an absolute path in the current users OpenCms site, without any webapp or servlet prefix.

参数:

value - the image source to set

setStyle

public void setStyle(java.lang.String value)

Sets the value of the HTML "style" attribute.

参数:

value - the value of the HTML "style" attribute to set

setTitle

public void setTitle(java.lang.String value)

Sets the value of the HTML "title" attribute.

参数:

value - the value of the HTML "title" attribute to set

setUsemap

public void setUsemap(java.lang.String value)

Sets the value of the HTML "usemap" attribute.

参数:

value - the value of the HTML "usemap" attribute to set

setVspace

public void setVspace(java.lang.String value)

Sets the value of the HTML "vspace" attribute.

参数:

value - the value of the HTML "vspace" attribute to set

setWidth

public void setWidth(java.lang.String value)

Sets the scaling width for the image.

If no valid integer is given, then "0" is used as value.

参数:

value - the scaling width for the image to set