com.atlassian.confluence.macro
Class DefaultImagePlaceholder

java.lang.Object
  extended by com.atlassian.confluence.macro.DefaultImagePlaceholder
All Implemented Interfaces:
ImagePlaceholder

public class DefaultImagePlaceholder
extends Object
implements ImagePlaceholder

Author:
Ryan Thomas

Constructor Summary
DefaultImagePlaceholder(String url, boolean applyPlaceholderChrome, ImageDimensions imageDimensions)
           
DefaultImagePlaceholder(String url, Dimensions dimensions, boolean applyPlaceholderChrome)
          Deprecated. 
 
Method Summary
 boolean applyPlaceholderChrome()
          Returns true if the image should have the macro placeholder chrome applied to it.
 Dimensions getDimensions()
          Returns the dimensions that the image is to be rendered as.
 String getUrl()
          Returns the url to the image to render, relative to the Confluence base url.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultImagePlaceholder

@Deprecated
public DefaultImagePlaceholder(String url,
                                          Dimensions dimensions,
                                          boolean applyPlaceholderChrome)
Deprecated. 


DefaultImagePlaceholder

public DefaultImagePlaceholder(String url,
                               boolean applyPlaceholderChrome,
                               ImageDimensions imageDimensions)
Method Detail

getUrl

public String getUrl()
Description copied from interface: ImagePlaceholder
Returns the url to the image to render, relative to the Confluence base url.

Specified by:
getUrl in interface ImagePlaceholder
Returns:
The url relative to the Confluence base url.

getDimensions

public Dimensions getDimensions()
Description copied from interface: ImagePlaceholder
Returns the dimensions that the image is to be rendered as. Returning null will render the image at its default size.

Specified by:
getDimensions in interface ImagePlaceholder
Returns:
An instance of Dimensions representing the image dimensions.

applyPlaceholderChrome

public boolean applyPlaceholderChrome()
Description copied from interface: ImagePlaceholder
Returns true if the image should have the macro placeholder chrome applied to it.

Specified by:
applyPlaceholderChrome in interface ImagePlaceholder
Returns:
True if placeholder chrome is to be applied.


Copyright © 2003–2015 Atlassian. All rights reserved.