Package com.github.bordertech.wcomponents

Class WMenuItemGroup

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.AbstractContainer

com.github.bordertech.wcomponents.WMenuItemGroup

All Implemented Interfaces:

Container, Disableable, MenuContainer, MenuItem, MenuItemGroup, WComponent, WebComponent, Serializable

@Deprecated
public class WMenuItemGroup
extends AbstractContainer
implements Disableable, MenuItemGroup

Deprecated.

menu groups are not compatible with WCAG 2.0.

This component provides a logical grouping of related menu items. The rendered version in the UI usually provides a visual grouping as well, including the menu item group's title.

Since:

1.0.0

Author:

Yiannis Paschalidis, Jonathan Austin

See Also:

Serialized Form

Nested Class Summary

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

AbstractWComponent.WComponentRef

Field Summary

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	Description
WMenuItemGroup(WDecoratedLabel label)	Deprecated. Creates a new WMenuItem containing the specified button.
WMenuItemGroup(String headingText)	Deprecated. Creates a new WMenuItem containing the specified button.

Method Summary

Modifier and Type	Method	Description
void	add(WMenuItem item)	Deprecated.
void	add(WSeparator item)	Deprecated.
void	add(WSubMenu item)	Deprecated.
void	addMenuItem(MenuItem item)	Deprecated.
void	addSeparator()	Deprecated. Adds a separator to this group.
WDecoratedLabel	getDecoratedLabel()	Deprecated.
String	getHeadingText()	Deprecated.
List<MenuItem>	getMenuItems()	Deprecated.
boolean	isDisabled()	Deprecated. Indicates whether this group is disabled.
void	remove(WComponent item)	Deprecated. Use removeMenuItem(com.github.bordertech.wcomponents.MenuItem) instead.
void	removeAllMenuItems()	Deprecated. Remove all menu items.
void	removeMenuItem(MenuItem item)	Deprecated.
void	setDisabled(boolean disabled)	Deprecated. Sets whether this group is disabled.
void	setHeadingText(String headingText)	Deprecated. Sets the group heading text.
String	toString()	Deprecated. Creates a String representation of this component; usually for debugging purposes.

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, getComponentModel, getDefaultModel, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getOrCreateComponentModel, getParent, getScratchMap, getTabIndex, getTag, getTemplate, getTemplateMarkUp, getToolTip, handleRequest, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, newComponentModel, 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

WMenuItemGroup

public WMenuItemGroup(String headingText)

Deprecated.

Creates a new WMenuItem containing the specified button.

Parameters:

headingText - the heading text for the group.

WMenuItemGroup

public WMenuItemGroup(WDecoratedLabel label)

Deprecated.

Creates a new WMenuItem containing the specified button.

Parameters:

label - the label for the group.

Method Detail

getDecoratedLabel

public WDecoratedLabel getDecoratedLabel()

Deprecated.

Returns:

the decorated label for this menu item group

getHeadingText

public String getHeadingText()

Deprecated.

Returns:

returns the group heading text.

setHeadingText

public void setHeadingText(String headingText)

Deprecated.

Sets the group heading text.

Parameters:

headingText - the heading to set.

isDisabled

public boolean isDisabled()

Deprecated.

Indicates whether this group is disabled.

Specified by:

isDisabled in interface Disableable

Returns:

true if this group is disabled.

setDisabled

public void setDisabled(boolean disabled)

Deprecated.

Sets whether this group is disabled.

Specified by:

setDisabled in interface Disableable

Parameters:

disabled - true to disable the group, false to enable it.

addSeparator

public void addSeparator()

Deprecated.

Adds a separator to this group.

add

public void add(WSeparator item)

Deprecated.

Parameters:

item - add a WSeparator

add

public void add(WMenuItem item)

Deprecated.

Parameters:

item - add a WMenuItem

add

public void add(WSubMenu item)

Deprecated.

Parameters:

item - add a WSubMenu

addMenuItem

public void addMenuItem(MenuItem item)

Deprecated.

Specified by:

addMenuItem in interface MenuContainer

Parameters:

item - the menu item to add

remove

@Deprecated
public void remove(WComponent item)

Deprecated.

Use removeMenuItem(com.github.bordertech.wcomponents.MenuItem) instead.

removeMenuItem

public void removeMenuItem(MenuItem item)

Deprecated.

Specified by:

removeMenuItem in interface MenuContainer

Parameters:

item - the menu item to remove

removeAllMenuItems

public void removeAllMenuItems()

Deprecated.

Remove all menu items.

Specified by:

removeAllMenuItems in interface MenuContainer

getMenuItems

public List<MenuItem> getMenuItems()

Deprecated.

Specified by:

getMenuItems in interface MenuContainer

Returns:

the items of this menu container

toString

public String toString()

Deprecated.

Description copied from class: AbstractWComponent

Creates a String representation of this component; usually for debugging purposes.

Overrides:

toString in class AbstractWComponent

Returns:

a String representation of this component, for debugging purposes.