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

Class WLibMenuItem

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.AbstractContainer

com.github.bordertech.wcomponents.WMenuItem

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

All Implemented Interfaces:

RelativeUrlBaseable, com.github.bordertech.wcomponents.AjaxTrigger, com.github.bordertech.wcomponents.Container, com.github.bordertech.wcomponents.DialogOpenTrigger, com.github.bordertech.wcomponents.Disableable, com.github.bordertech.wcomponents.MenuItem, com.github.bordertech.wcomponents.MenuItemSelectable, com.github.bordertech.wcomponents.WComponent, com.github.bordertech.wcomponents.WebComponent, Serializable

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

com.github.bordertech.wcomponents.WMenuItem.MenuItemModel

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
WLibMenuItem(String text) Creates a new WMenuItem with the specified text.
WLibMenuItem(String text, com.github.bordertech.wcomponents.Action action) Creates a WMenuItem with the given label and action.
WLibMenuItem(String text, char accessKey) Creates a new WMenuItem with the specified text and accessKey.
WLibMenuItem(String text, char accessKey, com.github.bordertech.wcomponents.Action action) Creates a new WMenuItem with the specified text, accessKey and action.
WLibMenuItem(String text, String url) Creates a WMenuItem with the given text and url.
WLibMenuItem(com.github.bordertech.wcomponents.WDecoratedLabel label) Creates a WMenuItem with the given label.
WLibMenuItem(com.github.bordertech.wcomponents.WDecoratedLabel label, com.github.bordertech.wcomponents.Action action) Creates a WMenuItem with the given label and action.
WLibMenuItem(com.github.bordertech.wcomponents.WDecoratedLabel label, String url) Creates a WMenuItem with the given label and url.

Method Summary

Methods

Modifier and Type	Method and Description
String	getUrl()
boolean	isRelativeBaseUrl()
void	setRelativeBaseUrl(boolean relativeBaseUrl)
void	setUrl(String url, boolean relativeBaseUrl)

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

getAccessKey, getAccessKeyAsString, getAction, getActionCommand, getActionObject, getComponentModel, getDecoratedLabel, getMessage, getOrCreateComponentModel, getSelectability, getTargetWindow, getText, handleRequest, isCancel, isDisabled, isMenuPresent, isSelectable, isSelectAllowed, isSelected, isSubmit, isTopLevelItem, newComponentModel, setAccessKey, setAction, setActionCommand, setActionObject, setCancel, setDisabled, setMessage, setSelectability, setSelectable, setTargetWindow, setText, setUrl, toString

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

getChildAt, getChildCount, getChildren, getIndexOfChild

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

WLibMenuItem

public WLibMenuItem(com.github.bordertech.wcomponents.WDecoratedLabel label)

Creates a WMenuItem with the given label.

Parameters:

label - the menu item label.

WLibMenuItem

public WLibMenuItem(com.github.bordertech.wcomponents.WDecoratedLabel label,
            String url)

Creates a WMenuItem with the given label and url.

Parameters:

label - the menu item label.

url - the URL to navigate to when the menu item is invoked.

WLibMenuItem

public WLibMenuItem(com.github.bordertech.wcomponents.WDecoratedLabel label,
            com.github.bordertech.wcomponents.Action action)

Creates a WMenuItem with the given label and action.

Parameters:

label - the menu item label.

action - the action to execute when the menu item is invoked.

WLibMenuItem

public WLibMenuItem(String text,
            String url)

Creates a WMenuItem with the given text and url.

Parameters:

text - the menu item text.

url - the URL to navigate to when the menu item is invoked.

WLibMenuItem

public WLibMenuItem(String text,
            com.github.bordertech.wcomponents.Action action)

Creates a WMenuItem with the given label and action.

Parameters:

text - the menu item text.

action - the action to execute when the menu item is invoked.

WLibMenuItem

public WLibMenuItem(String text)

Creates a new WMenuItem with the specified text.

Parameters:

text - the menu item's text.

WLibMenuItem

public WLibMenuItem(String text,
            char accessKey)

Creates a new WMenuItem with the specified text and accessKey.

Parameters:

text - the menu item's text.

accessKey - the menu item's access key.

WLibMenuItem

public WLibMenuItem(String text,
            char accessKey,
            com.github.bordertech.wcomponents.Action action)

Creates a new WMenuItem with the specified text, accessKey and action.

Parameters:

text - the menu item's text.

accessKey - the menu item's access key.

action - the action to execute when the menu item is invoked.

Method Detail

setUrl

public void setUrl(String url,
          boolean relativeBaseUrl)

Parameters:

url - the URL to navigate to

relativeBaseUrl - true if use relative to base URL

getUrl

public String getUrl()

Overrides:

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

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