Package ch.tocco.nice2.model.form.api.components

Interface LabeledComponent

All Superinterfaces:

Component

All Known Subinterfaces:

Action, ActionSeparator, AmountField, BirthDateField, Box, Checkbox, CodeField, Column, ComboBox, Container, CreatePasswordField, CustomDataField, DataComponent, DateField, DatetimeField, DescriptionField, DisplayExpressionField, DisplayField, DocumentField, DurationField, EmailField, Field, Form, HorizontalBox, HtmlField, ImageField, InputComponent, IteratorComponent, LatitudeField, LocationField, LoginField, LongitudeField, MoneyAmountField, MultiRemoteField, MultiSelectBox, NamedUploadField, NumberField, PasswordField, PathField, PercentField, PhoneField, PositionSearchField, PulldownDateField, RangeField, RemoteField, SearchFilterComponent, SearchFilterField, SingleSelectBox, Table, Template, TextArea, TextField, TimeField, UploadField, UrlField, UuidField, VerticalBox

All Known Implementing Classes:

AbstractBox, AbstractDataComponent, AbstractDocumentField, AbstractLabeledComponent, ActionSeparatorImpl, ActionSeparatorWrapper, ActionWrapper, AmountFieldImpl, AmountFieldWrapper, BirthDateFieldImpl, BirthDateFieldWrapper, BoxWrapper, CheckboxImpl, CheckboxWrapper, CodeFieldImpl, CodeFieldWrapper, ColumnWrapper, ComboBoxImpl, ComboBoxWrapper, ContainerImpl, ContainerWrapper, CreatePasswordFieldImpl, CreatePasswordFieldWrapper, CustomDataFieldImpl, CustomDataFieldWrapper, DataComponentWrapper, DateFieldImpl, DateFieldWrapper, DatetimeFieldImpl, DatetimeFieldWrapper, DefaultAction, DefaultColumn, DefaultIteratorComponent, DefaultTable, DefaultTemplate, DescriptionFieldImpl, DescriptionFieldWrapper, DisplayExpressionFieldImpl, DisplayExpressionFieldWrapper, DisplayFieldImpl, DisplayFieldWrapper, DocumentFieldImpl, DocumentFieldWrapper, DurationFieldImpl, DurationFieldWrapper, EmailFieldImpl, EmailFieldWrapper, FieldImpl, FieldWrapper, FormWrapper, HorizontalBoxImpl, HorizontalBoxWrapper, HtmlFieldImpl, HtmlFieldWrapper, ImageFieldImpl, ImageFieldWrapper, InputComponentWrapper, IteratorComponentWrapper, LabeledComponentWrapper, LatitudeFieldImpl, LatitudeFieldImpl.LatitudeFieldWrapper, LocationFieldImpl, LocationFieldWrapper, LoginFieldImpl, LoginFieldWrapper, LongitudeFieldImpl, LongitudeFieldImpl.LongitudeFieldWrapper, MoneyAmountFieldImpl, MoneyAmountFieldImpl.MoneyAmountFieldWrapper, MultiRemoteFieldImpl, MultiRemoteFieldWrapper, MultiSelectBoxImpl, MultiSelectBoxWrapper, NamedUploadFieldImpl, NamedUploadFieldWrapper, NumberFieldImpl, NumberFieldWrapper, PasswordFieldImpl, PasswordFieldWrapper, PathFieldImpl, PathFieldWrapper, PercentFieldImpl, PercentFieldWrapper, PhoneFieldImpl, PhoneFieldWrapper, PositionSearchFieldImpl, PositionSearchFieldImpl.PositionSearchFieldWrapper, PulldownDateFieldImpl, PulldownDateFieldWrapper, RangeFieldImpl, RangeFieldWrapper, RemoteFieldImpl, RemoteFieldWrapper, SearchFilterFieldImpl, SearchFilterFieldWrapper, SimpleForm, SingleSelectBoxImpl, SingleSelectBoxWrapper, TableWrapper, TemplateWrapper, TextAreaImpl, TextAreaWrapper, TextFieldImpl, TextFieldWrapper, TimeFieldImpl, TimeFieldWrapper, UploadFieldImpl, UploadFieldWrapper, UrlFieldImpl, UrlFieldWrapper, UuidFieldImpl, UuidFieldWrapper, VerticalBoxImpl, VerticalBoxWrapper

@Deprecated
public interface LabeledComponent
extends Component

Deprecated.

A component that can have, and usually does have, a label. The label may still be set to not use, see getUseLabel().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	LabeledComponent.UseLabel	Deprecated. If the label of this component is to be used in the gui.

Nested classes/interfaces inherited from interface ch.tocco.nice2.model.form.api.components.Component

Component.ComponentFilter, Component.DataNavigationType, Component.DisplayType, Component.Position

Method Summary

Modifier and Type	Method	Description
DisplayValue	getLabel()	Deprecated.
LabeledComponent.UseLabel	getUseLabel()	Deprecated. Tells if the label is to be used in the gui.
void	setLabel(DisplayValue value)	Deprecated.
void	setUseLabel(LabeledComponent.UseLabel useLabel)	Deprecated. Sets wheter the label is to be used in the gui.

Methods inherited from interface ch.tocco.nice2.model.form.api.components.Component

addComponent, addComponent, collectDataParts, collectDataParts, createCopy, createCopy, find, findByName, findByType, findFirst, findFirstByName, getAttributeProps, getChild, getChildren, getDataNavigationType, getDisplayType, getEventHandler, getExtProps, getForm, getName, getParent, getParentOrEx, getPosition, getRelativeToPositionName, getScopes, getType, hasParent, isForceEditable, isLeaf, isReplace, overrideParent, removeComponent, replaceComponent, replaceComponent, setAttributeProps, setChildren, setDisplayType, setEventHandler, setExtProps, setForceEditable, setName, setPosition, setRelativeToPositionName, setReplace, setScopes, wrap

Method Details

getLabel

DisplayValue getLabel()

Deprecated.

setLabel

void setLabel(DisplayValue value)

Deprecated.

Parameters:

value - value

Throws:

IllegalStateException - when trying to change the model after finished model-reading

getUseLabel

LabeledComponent.UseLabel getUseLabel()

Deprecated.

Tells if the label is to be used in the gui.

Returns:

Tells if and how the label should be used.

setUseLabel

void setUseLabel(LabeledComponent.UseLabel useLabel)

Deprecated.

Sets wheter the label is to be used in the gui.

Parameters:

useLabel - true to use it, false to ignore it