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

Class WLibLink

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WBeanComponent

com.github.bordertech.wcomponents.WLink

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

All Implemented Interfaces:

RelativeUrlBaseable, com.github.bordertech.wcomponents.AjaxInternalTrigger, com.github.bordertech.wcomponents.AjaxTarget, com.github.bordertech.wcomponents.BeanAware, com.github.bordertech.wcomponents.BeanBound, com.github.bordertech.wcomponents.BeanProviderBound, com.github.bordertech.wcomponents.Container, com.github.bordertech.wcomponents.DataBound, com.github.bordertech.wcomponents.Disableable, com.github.bordertech.wcomponents.SubordinateTarget, com.github.bordertech.wcomponents.WComponent, com.github.bordertech.wcomponents.WebComponent, Serializable

public class WLibLink
extends com.github.bordertech.wcomponents.WLink
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.WLink

com.github.bordertech.wcomponents.WLink.Builder, com.github.bordertech.wcomponents.WLink.ImagePosition, com.github.bordertech.wcomponents.WLink.LinkModel, com.github.bordertech.wcomponents.WLink.WindowAttributes

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
WLibLink() Creates a WLink.
WLibLink(String text, String url) Creates a WLink with the given text and url.

Method Summary

Methods

Modifier and Type	Method and Description
String	getImageUrl()
String	getUrl()
boolean	isImageRelativeBaseUrl()
boolean	isRelativeBaseUrl()
void	setImageRelativeBaseUrl(boolean relativeBaseUrl)
void	setImageUrl(String imageUrl, boolean relativeBaseUrl)
void	setRelativeBaseUrl(boolean relativeBaseUrl)
void	setUrl(String url, boolean relativeBaseUrl)

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

getAccessKey, getAccessKeyAsString, getAction, getActionCommand, getActionObject, getActionTargets, getChildAt, getChildCount, getChildren, getComponentModel, getImage, getImageHolder, getImagePosition, getIndexOfChild, getOpenNewWindow, getOrCreateComponentModel, getRel, getTargetWindowName, getText, getWindowAttrs, handleRequest, isDisabled, isRenderAsButton, newComponentModel, preparePaintComponent, setAccessKey, setAction, setActionCommand, setActionObject, setDisabled, setImage, setImage, setImagePosition, setImageUrl, setOpenNewWindow, setRel, setRenderAsButton, setTargetWindowName, setText, setUrl, setWindowAttrs, 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, 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

WLibLink

public WLibLink()

Creates a WLink.

WLibLink

public WLibLink(String text,
        String url)

Creates a WLink with the given text and url.

Parameters:

text - the link test to display.

url - the link url.

Method Detail

setUrl

public void setUrl(String url,
          boolean relativeBaseUrl)

Parameters:

url - the URL link

relativeBaseUrl - true if use relative to base URL

getUrl

public String getUrl()

Overrides:

getUrl in class com.github.bordertech.wcomponents.WLink

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.WLink

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

setImageRelativeBaseUrl

public void setImageRelativeBaseUrl(boolean relativeBaseUrl)

Parameters:

relativeBaseUrl - true if Image URL is relative to base URL

isImageRelativeBaseUrl

public boolean isImageRelativeBaseUrl()

Returns:

true if Image URL is relative to base URL