com.ephox.editlive.custom
Interface ImageDialogComponent


public interface ImageDialogComponent

Interface for all custom components to be used in the standard insert image dialog. Implementing classes must use a constructor that takes an array of Objects (the same ones passed in when registering the component).

See Also:
ELJBean.addImageDialogComponent(Class, Object[])

Method Summary
 void cleanUp()
          Called during the dialog dispose() method.
 Map<String,?> getAttributeMap(Map<String,?> in)
          Returns a Map of the attributes to be used in the IMG tag.
 ImageIcon getButtonImage()
          Returns the image to be displayed in the repository selection toggle button.
 String getButtonText()
          Returns the text to be displayed in the repository selection toggle button.
 JComponent getJComponent()
          Returns the JComponent to display when this ImageDialogComponent is selected.
 void setImageDialog(ImageDialog parent)
          Sets the ImageDialog parent of this component.
 

Method Detail

setImageDialog

void setImageDialog(ImageDialog parent)
Sets the ImageDialog parent of this component.


getAttributeMap

Map<String,?> getAttributeMap(Map<String,?> in)
Returns a Map of the attributes to be used in the IMG tag. The attributes should be stored as a name/value pair of Strings. e.g. "src", "http://www.myserver.com/images/myimage.jpg"

Parameters:
in - a Map containing the current attributes selected in the image dialog.
Returns:
a Map containing name/value pairs of attributes for the image tag.

getButtonText

String getButtonText()
Returns the text to be displayed in the repository selection toggle button.

Returns:
Text to be displayed.

getButtonImage

ImageIcon getButtonImage()
Returns the image to be displayed in the repository selection toggle button.

Returns:
Image to be displayed.

getJComponent

JComponent getJComponent()
Returns the JComponent to display when this ImageDialogComponent is selected.

Returns:
JComponent to display

cleanUp

void cleanUp()
Called during the dialog dispose() method. Any cleanup that is required should be done here.


Copyright (c) 2005-2012 Ephox Pty Ltd. All rights reserved.