Package com.github.bordertech.wcomponents

Interface Mandatable

All Superinterfaces:

Serializable, WComponent, WebComponent

All Known Subinterfaces:

Input

All Known Implementing Classes:

AbstractInput, AbstractWMultiSelectList, AbstractWSelectList, AbstractWSingleSelectList, RadioButtonGroup, WCheckBox, WCheckBoxSelect, WDateField, WDropdown, WEmailField, WFieldSet, WFileWidget, WMultiDropdown, WMultiFileWidget, WMultiSelect, WMultiSelectPair, WMultiTextField, WNumberField, WPartialDateField, WPasswordField, WPhoneNumberField, WRadioButtonSelect, WShuffler, WSingleSelect, WTextArea, WTextField, WToggleButton, WTree

public interface Mandatable
extends WComponent

Expresses the notion that a WComponent can handle the idea of being "mandatory" or "optional".

Since:

1.0.0

Author:

Jonathan Austin

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	isMandatory()	Indicates whether or not this component is mandatory.
void	setMandatory(boolean mandatory)	Set whether or not this component is mandatory.

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

setMandatory

void setMandatory(boolean mandatory)

Set whether or not this component is mandatory.

Parameters:

mandatory - true for mandatory, false for optional.

isMandatory

boolean isMandatory()

Indicates whether or not this component is mandatory.

Returns:

true if the input is mandatory, false otherwise.