AccessKeyable (wcomponents-core 1.5.24 API)

All Superinterfaces:

Serializable, WComponent, WebComponent

All Known Implementing Classes:

UicProfileButton, WAjaxPollingRegion, WButton, WCancelButton, WConfirmationButton, WLabel, WLink, WMenuItem, WMessages, WPanel, WPrintButton, WSubMenu, WTab
```
public interface AccessKeyable
extends WComponent
```
Components that can have an access key.

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`char`	`getAccessKey()`
`default String`	`getAccessKeyAsString()`	Returns the access key character as a String.
`void`	`setAccessKey(char accessKey)`	Set the access key on the component.

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

- Method Detail
  - getAccessKey
```
char getAccessKey()
```
    Returns:
    
    the component's access key.
  - setAccessKey
```
void setAccessKey(char accessKey)
```
    Set the access key on the component.
    
    Parameters:
    
    accessKey - the key that will form a keyboard shortcut to the component.
  - getAccessKeyAsString
```
default String getAccessKeyAsString()
```
    Returns the access key character as a String. If the character is not a letter or digit then null is returned.
    
    Returns:
    
    the access key character as a String (may be null).