Package org.opencms.ade.galleries.client.preview

Class CmsImagePreviewHandler

java.lang.Object

org.opencms.ade.galleries.client.preview.A_CmsPreviewHandler<org.opencms.ade.galleries.shared.CmsImageInfoBean>

org.opencms.ade.galleries.client.preview.CmsImagePreviewHandler

All Implemented Interfaces:

com.google.gwt.event.logical.shared.ValueChangeHandler<CmsCroppingParamBean>, com.google.gwt.event.shared.EventHandler, I_CmsPreviewHandler<org.opencms.ade.galleries.shared.CmsImageInfoBean>, I_CmsPropertiesHandler

public class CmsImagePreviewHandler
extends A_CmsPreviewHandler<org.opencms.ade.galleries.shared.CmsImageInfoBean>
implements com.google.gwt.event.logical.shared.ValueChangeHandler<CmsCroppingParamBean>

Image preview dialog controller handler.

Delegates the actions of the preview controller to the preview dialog.

Since:

8.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CmsImagePreviewHandler.Attribute	Enumeration of image tag attribute names.
static class	CmsImagePreviewHandler.PreviewImageUpdate	Encapsulates information used to update the preview image's scaling parameters.

Field Summary

Fields inherited from class org.opencms.ade.galleries.client.preview.A_CmsPreviewHandler

m_resourceInfo, m_resourcePreview

Constructor Summary

Constructors

Constructor	Description
CmsImagePreviewHandler(CmsImageResourcePreview resourcePreview)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addCroppingChangeHandler(Runnable action)	Adds a handler for cropping changes.
void	addImagePointChangeHandler(Runnable onImagePointChanged)	Adds a handler for focal point changes.
static final String	appendQuality(String text)	Appends quality parameter to a set of scaling parameters, unless the input is the empty string or already contains a quality parameter.
CmsCroppingParamBean	getCroppingParam()	Returns the image cropping parameter bean.
CmsFocalPointController	getFocalPointController()	Gets the focal point controller.
CmsImageFormatHandler	getFormatHandler()	Gets the format handler.
String	getFormatName()	Returns the name of the currently selected image format.
void	getImageAttributes(I_CmsSimpleCallback<Map<String,String>> callback)	Returns image tag attributes to set for editor plugins.
int	getImageIdHash()	Returns the structure id hash of the previewed image.
org.opencms.ade.galleries.shared.CmsImageInfoBean	getImageInfo()	Gets the image information.
CmsImagePreviewHandler.PreviewImageUpdate	getPreviewImageUpdate(int imageHeight, int imageWidth)	Gets the information to update the preview image.
String	getPreviewScaleParam(int imageHeight, int imageWidth, int density)	Returns the cropping parameter.
void	onValueChange(com.google.gwt.event.logical.shared.ValueChangeEvent<CmsCroppingParamBean> event)
void	setFormatHandler(CmsImageFormatHandler formatHandler)	Sets the image format handler.
void	setImageContainerSize(int offsetWidth, int offsetHeight)	Sets the dimensions of the area the image is going to be placed in.

Methods inherited from class org.opencms.ade.galleries.client.preview.A_CmsPreviewHandler

closePreview, getAdditionalWidgetForPropertyTab, getGalleryDialog, saveProperties, selectResource, setDataInEditor, showData

Methods inherited from class java.lang.Object

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

Constructor Details

CmsImagePreviewHandler

public CmsImagePreviewHandler(CmsImageResourcePreview resourcePreview)

Constructor.

Parameters:

resourcePreview - the resource preview instance

Method Details

appendQuality

public static final String appendQuality(String text)

Appends quality parameter to a set of scaling parameters, unless the input is the empty string or already contains a quality parameter.

Parameters:

text - the input scaling parameters

Returns:

the modified scaling parameters

addCroppingChangeHandler

public void addCroppingChangeHandler(Runnable action)

Adds a handler for cropping changes.

Parameters:

action - the handler to add

addImagePointChangeHandler

public void addImagePointChangeHandler(Runnable onImagePointChanged)

Adds a handler for focal point changes.

Parameters:

onImagePointChanged - the handler to add

getCroppingParam

public CmsCroppingParamBean getCroppingParam()

Returns the image cropping parameter bean.

Returns:

the image cropping parameter bean

getFocalPointController

public CmsFocalPointController getFocalPointController()

Gets the focal point controller.

Returns:

the focal point controller

getFormatHandler

public CmsImageFormatHandler getFormatHandler()

Gets the format handler.

Returns:

the format handler

getFormatName

public String getFormatName()

Returns the name of the currently selected image format.

Returns:

the format name

getImageAttributes

public void getImageAttributes(I_CmsSimpleCallback<Map<String,String>> callback)

Returns image tag attributes to set for editor plugins.

Parameters:

callback - the callback to execute

getImageIdHash

public int getImageIdHash()

Returns the structure id hash of the previewed image.

Returns:

the structure id hash

getImageInfo

public org.opencms.ade.galleries.shared.CmsImageInfoBean getImageInfo()

Gets the image information.

Returns:

the image information

getPreviewImageUpdate

public CmsImagePreviewHandler.PreviewImageUpdate getPreviewImageUpdate(int imageHeight,
 int imageWidth)

Gets the information to update the preview image.

Parameters:

imageHeight - the original image height

imageWidth - the original image width

Returns:

the preview update information

getPreviewScaleParam

public String getPreviewScaleParam(int imageHeight,
 int imageWidth,
 int density)

Returns the cropping parameter.

Parameters:

imageHeight - the original image height

imageWidth - the original image width

density - the pixel density (acts as a multiplier for available space)

Returns:

the cropping parameter

onValueChange

public void onValueChange(com.google.gwt.event.logical.shared.ValueChangeEvent<CmsCroppingParamBean> event)

Specified by:

onValueChange in interface com.google.gwt.event.logical.shared.ValueChangeHandler<CmsCroppingParamBean>

See Also:

• ValueChangeHandler.onValueChange(com.google.gwt.event.logical.shared.ValueChangeEvent)

setFormatHandler

public void setFormatHandler(CmsImageFormatHandler formatHandler)

Sets the image format handler.

Parameters:

formatHandler - the format handler

setImageContainerSize

public void setImageContainerSize(int offsetWidth,
 int offsetHeight)

Sets the dimensions of the area the image is going to be placed in.

Parameters:

offsetWidth - the container width

offsetHeight - the container height