com.github.bordertech.wcomponents.addons.common.relative

Class WLibImage

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WBeanComponent

com.github.bordertech.wcomponents.WImage

com.github.bordertech.wcomponents.addons.common.relative.WLibImage

All Implemented Interfaces:

RelativeUrlBaseable, com.github.bordertech.wcomponents.AjaxTarget, com.github.bordertech.wcomponents.BeanAware, com.github.bordertech.wcomponents.BeanBound, com.github.bordertech.wcomponents.BeanProviderBound, com.github.bordertech.wcomponents.DataBound, com.github.bordertech.wcomponents.Targetable, com.github.bordertech.wcomponents.WComponent, com.github.bordertech.wcomponents.WebComponent, Serializable

public class WLibImage
extends com.github.bordertech.wcomponents.WImage
implements RelativeUrlBaseable

Allows a relative base URL to be used so the URL can be used in different contexts without changing.

This will be put into WComponents core.

Author:

jonathan

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.WImage

com.github.bordertech.wcomponents.WImage.ImageModel

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.AbstractWComponent.WComponentRef

Field Summary

Fields inherited from interface com.github.bordertech.wcomponents.addons.common.relative.RelativeUrlBaseable

RELATIVE_FLAG_ATTR

Fields inherited from interface com.github.bordertech.wcomponents.WComponent

DEFAULT_APPLICATION_ID, DEFAULT_INTERNAL_ID, DEFAULT_NO_ID, ID_CONTEXT_SEPERATOR, ID_FRAMEWORK_ASSIGNED_SEPERATOR, ID_VALIDATION_PATTERN

Constructor Summary

Constructors

Constructor and Description
WLibImage() Creates a WImage with no content.
WLibImage(com.github.bordertech.wcomponents.ImageResource image) Creates a WImage with the given image resource.
WLibImage(String imageResource, String description) Creates a WImage with the given static content.

Method Summary

Methods

Modifier and Type	Method and Description
String	getImageUrl()
boolean	isRelativeBaseUrl()
void	setImageUrl(String imageUrl, boolean relativeBaseUrl)
void	setRelativeBaseUrl(boolean relativeBaseUrl)

Methods inherited from class com.github.bordertech.wcomponents.WImage

getAlternativeText, getCacheKey, getComponentModel, getImage, getOrCreateComponentModel, getSize, getTargetId, getTargetUrl, handleRequest, newComponentModel, setAlternativeText, setCacheKey, setImage, setImageUrl, setSize, toString

Methods inherited from class com.github.bordertech.wcomponents.WBeanComponent

addBeanToScratchMap, doUpdateBeanValue, getBean, getBeanFromScratchMap, getBeanId, getBeanProperty, getBeanProvider, getBeanScratchMap, getBeanValue, getData, isBeanInScratchMap, isChanged, isSearchAncestors, isUseRequestScopeScratchMap, removeBeanFromScratchMap, resetData, setBean, setBeanId, setBeanProperty, setBeanProvider, setData, setSearchAncestors, updateBeanValue

Methods inherited from class com.github.bordertech.wcomponents.AbstractWComponent

addHtmlClass, addHtmlClass, addNotify, afterPaint, assertAddSupported, beforePaint, createErrorDiagnostic, createErrorDiagnostic, forward, getAccessibleText, getAttribute, getBaseUrl, getDefaultModel, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getScratchMap, getTabIndex, getTag, getTemplate, getTemplateMarkUp, getToolTip, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, paintComponent, preparePaint, preparePaintComponent, removeAttribute, removeComponentModel, removeHtmlClass, removeHtmlClass, removeNotify, replaceWComponent, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFlag, setFocussed, setHidden, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showErrorIndicatorsForComponent, showWarningIndicators, showWarningIndicatorsForComponent, tidyUpUIContext, tidyUpUIContextForTree, validate, validateComponent, writeReplace

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.bordertech.wcomponents.WComponent

addHtmlClass, addHtmlClass, forward, getAccessibleText, getAttribute, getBaseUrl, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getTabIndex, getTag, getToolTip, handleRequest, hasTabIndex, invokeLater, isDefaultState, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, preparePaint, removeAttribute, removeHtmlClass, removeHtmlClass, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFocussed, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showWarningIndicators, tidyUpUIContextForTree, validate

Constructor Detail

WLibImage

public WLibImage()

Creates a WImage with no content.

WLibImage

public WLibImage(String imageResource,
         String description)

Creates a WImage with the given static content. This is provided as a convenience method for when the image is included as static content in the class path rather than in the web application's resources.

The mime type for the image is looked up from the "mimeType.*" mapping configuration parameters using the resource's file extension.

Parameters:

imageResource - the resource path to the image file.

description - the image description.

WLibImage

public WLibImage(com.github.bordertech.wcomponents.ImageResource image)

Creates a WImage with the given image resource.

Parameters:

image - the image resource

Method Detail

setImageUrl

public void setImageUrl(String imageUrl,
               boolean relativeBaseUrl)

Parameters:

imageUrl - the image URL

relativeBaseUrl - true if use relative to base URL

getImageUrl

public String getImageUrl()

Overrides:

getImageUrl in class com.github.bordertech.wcomponents.WImage

setRelativeBaseUrl

public void setRelativeBaseUrl(boolean relativeBaseUrl)

Specified by:

setRelativeBaseUrl in interface RelativeUrlBaseable

Parameters:

relativeBaseUrl - true if URL is relative to base URL

isRelativeBaseUrl

public boolean isRelativeBaseUrl()

Specified by:

isRelativeBaseUrl in interface RelativeUrlBaseable

Returns:

true if URL is relative to base URL