Package com.github.bordertech.wcomponents

Interface Disableable

All Superinterfaces:

Serializable, WComponent, WebComponent

All Known Subinterfaces:

Input

All Known Implementing Classes:

AbstractInput, AbstractWMultiSelectList, AbstractWSelectList, AbstractWSingleSelectList, RadioButtonGroup, UicProfileButton, WAudio, WButton, WCancelButton, WCheckBox, WCheckBoxSelect, WConfirmationButton, WContentLink, WDataTable, WDateField, WDropdown, WEmailField, WFileWidget, WLink, WMenu, WMenuItem, WMenuItemGroup, WMultiDropdown, WMultiFileWidget, WMultiSelect, WMultiSelectPair, WMultiTextField, WNumberField, WPartialDateField, WPasswordField, WPhoneNumberField, WPrintButton, WRadioButton, WRadioButtonSelect, WSelectToggle, WShuffler, WSingleSelect, WSubMenu, WTab, WTabGroup, WTabSet, WTextArea, WTextField, WToggleButton, WTree, WVideo

public interface Disableable
extends WComponent

Expresses the notion that a WComponent can handle the idea of being "enabled" or "disabled".

Since:

1.0.0

Author:

James Gifford

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

Modifier and Type	Method	Description
boolean	isDisabled()	Indicates whether the Disableable is disabled.
void	setDisabled(boolean disabled)	Sets whether the Disableable is disabled.

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

isDisabled

boolean isDisabled()

Indicates whether the Disableable is disabled.

Returns:

true if the Disableable is disabled, otherwise false.

setDisabled

void setDisabled(boolean disabled)

Sets whether the Disableable is disabled.

Parameters:

disabled - if true, the Disableable is disabled. If false, it is enabled.