com.ephox.editlive.custom
Interface HyperlinkDialogComponent


public interface HyperlinkDialogComponent

Interface for all custom components to be used in the standard insert hyperlink 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.addHyperlinkDialogComponent(Class, Object[])

Method Summary
 void cleanUp()
          Called as the dialog is being disposed.
 Map<String,?> getAttributeMap(Map<String,?> in)
          Returns a Map of the attributes to be used in the A 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 HyperlinkDialogComponent is selected.
 void setActive(boolean active)
          Sets the current component status.
 void setHyperlinkDialog(HyperlinkDialog parent)
          Sets the HyperlinkDialog parent to be called back into.
 

Method Detail

setHyperlinkDialog

void setHyperlinkDialog(HyperlinkDialog parent)
Sets the HyperlinkDialog parent to be called back into.


getAttributeMap

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

Parameters:
in - a Map containing the current attributes selected in the hyperlink dialog.
Returns:
a Map containing name/value pairs of attributes for the A 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 HyperlinkDialogComponent is selected.

Returns:
JComponent to display

setActive

void setActive(boolean active)
Sets the current component status. If false then the dialog is not currently visible.

Parameters:
active - Status of the component.

cleanUp

void cleanUp()
Called as the dialog is being disposed. Any cleanup that is required should be done here.


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