com.guiseframework.model
Interface LabelModel

All Superinterfaces:

Model, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable

All Known Subinterfaces:

ActionControl, ActionPrototype, ActionValueControl<V>, ApplicationFrame, ArrangeContainer, Box, ButtonControl, CardContainer, CardControl, Component, CompositeComponent, Container, ContainerControl, ContentComponent, Control, DialogFrame<V>, EditComponent, FlyoverFrame, Frame, HeadingComponent, ImageComponent, InfoModel, InputFocusableComponent, InputFocusGroupComponent, LabelComponent, LabelDisplayableComponent, LayoutComponent, LayoutControl, LinkControl, ListSelectControl<V>, Menu, ModalComponent<M>, ModalFrame<R>, ModalNavigationPanel<R>, OptionDialogFrame<O>, Panel, PendingImageComponent, SelectActionControl, SelectButtonControl, SelectControl<V>, SelectLinkControl, TableColumnModel<V>, ToolButtonControl, URFResourceAlterationComponent, ValueControl<V>, ValuedComponent<V>, Widget

All Known Implementing Classes:

AboutPanel, AbstractActionControl, AbstractActionPrototype, AbstractActionValueControl, AbstractApplicationFrame, AbstractArrayCompositeComponent, AbstractBooleanSelectActionControl, AbstractBox, AbstractButtonControl, AbstractCardPanel, AbstractComponent, AbstractCompositeComponent, AbstractCompositeStateComponent, AbstractCompositeStateControl, AbstractContainer, AbstractContainerControl, AbstractContainerValueControl, AbstractControl, AbstractDialogFrame, AbstractEditComponentTextControl, AbstractEditValueControl, AbstractEditValuePanel, AbstractEnableablePrototype, AbstractEnableableProxyPrototype, AbstractEnumCompositeComponent, AbstractFlyoverFrame, AbstractFrame, AbstractImageComponent, AbstractLabel, AbstractLayoutComponent, AbstractLayoutControl, AbstractLayoutValueControl, AbstractLinkControl, AbstractListCompositeComponent, AbstractListSelectContainerControl, AbstractListSelectControl, AbstractMenu, AbstractModalFrame, AbstractModalNavigationPanel, AbstractMultipleCompositeComponent, AbstractOptionDialogFrame, AbstractPanel, AbstractPrototype, AbstractProxyPrototype, AbstractSelectActionControl, AbstractSelectActionValueControl, AbstractSequenceTaskPanel, AbstractSingleCompositeComponent, AbstractTextControl, AbstractValueControl, AbstractValuedPanel, AccordionMenu, ArrangePanel, AuthorizeUsersPanel, AutoNavigationPathBreadcrumbLinkPanel, BookDescriptionPanel, BookmarksPanel, BooleanSelectButton, BooleanSelectLink, BooleanSelectToolButton, BooleanValueControlSelectControl, Breadcrumb, BusyPanel, Button, CalendarControl, CalendarDialogFrame, CalendarMonthTableModel.WeekDayTableColumnModel, CalendarsPanel, CardConstraints, CardPanel, CardTabControl, CheckControl, DateTimeControl, DateTimeFieldsControl, DefaultApplicationFrame, DefaultDialogFrame, DefaultFlyoverFrame, DefaultFrame, DefaultInfoModel, DefaultLabelModel, DefaultModalFrame, DefaultModalNavigationPanel, DefaultTableColumnModel, DiagnosticPanel, DropDetailsPanel, DropMenu, EditComponentLabelControl, EditComponentTextControl, EditUserPanel, EditUsersPanel, EventWizardPanel, EventWizardPanel.BusinessAddressPanel, EventWizardPanel.BusinessNamePanel, EventWizardPanel.EventNamePanel, EventWizardPanel.PersonalAgePanel, EventWizardPanel.PersonalEmailPanel, EventWizardPanel.PersonalNamePanel, EventWizardPanel2, Flash, GenerateContentPanel, GroupPanel, Heading, HeadingLink, HelloUserPanel, HelloWorldPanel, HomePanel, HomePanel.TestFrame, Image, ImageActionControl, ImageBooleanSelectActionControl, ImageOpacityPanel, InternationalizationPanel, Label, LabelPrototype, LayoutPanel, Link, ListControl, LocaleInfoModel, LoginPanel, MarmotPanel, MenuPrototype, MenusPanel, Message, MessageOptionDialogFrame, MultiplicationTablePanel, NamePanel, NavigateActionPrototype, NavigationPathBreadcrumbLinkPanel, Notification, NotificationOptionDialogFrame, PasswordAuthenticationPanel, PendingImage, PendingImageActionControl, Picture, PlatformFileUploadPanel, ProxyActionPrototype, RDFPropertyTableColumnModel, RDFResourceURITableColumnModel, ResourceCollectControl, ResourceImportControl, RestrictedPanel, RichTextEditPanel, ScrollControl, SectionPanel, SelectableLabel, SelectButton, SelectLink, SequenceCardPanel, SliderControl, SpinnerControl, TabbedPanel, TabContainerControl, TabControl, Table, Table.DefaultCellMessage, TabsPanel, TaskCardConstraints, TaskStateSelectLink, TemperatureConversionPanel, TemperatureConversionPanel2, TextBox, TextControl, TextSearchPanel, TogglePrototype, Toolbar, ToolButton, TreeControl, URFProcessPanel, URFPropertyTableColumnModel, URFResourceURITableColumnModel, ValueConverterInfoModel, ValuePrototype, ValueSelectButton, ValueSelectLink

public interface LabelModel
extends Model

A model for an identifier such as text and/or an icon.

Author:

Garret Wilson

Field Summary

static java.lang.String	GLYPH_URI_PROPERTY The icon bound property.
static java.lang.String	LABEL_CONTENT_TYPE_PROPERTY The label content type bound property.
static java.lang.String	LABEL_PROPERTY The label bound property.

Fields inherited from interface com.guiseframework.model.Model

PLAIN_TEXT_CONTENT_TYPE, XHTML_CONTENT_TYPE, XHTML_FRAGMENT_CONTENT_TYPE

Method Summary

java.net.URI	getGlyphURI()
java.lang.String	getLabel()
com.globalmentor.net.ContentType	getLabelContentType()
void	setGlyphURI(java.net.URI newIcon) Sets the URI of the icon.
void	setLabel(java.lang.String newLabelText) Sets the text of the label.
void	setLabelContentType(com.globalmentor.net.ContentType newLabelTextContentType) Sets the content type of the label text.

Methods inherited from interface com.globalmentor.beans.PropertyBindable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface com.globalmentor.beans.PropertyConstrainable

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, hasVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Field Detail

GLYPH_URI_PROPERTY

static final java.lang.String GLYPH_URI_PROPERTY

The icon bound property.

LABEL_PROPERTY

static final java.lang.String LABEL_PROPERTY

The label bound property.

LABEL_CONTENT_TYPE_PROPERTY

static final java.lang.String LABEL_CONTENT_TYPE_PROPERTY

The label content type bound property.

Method Detail

getGlyphURI

java.net.URI getGlyphURI()

Returns:

The glyph URI, which may be a resource URI, or null if there is no glyph URI.

setGlyphURI

void setGlyphURI(java.net.URI newIcon)

Sets the URI of the icon. This is a bound property.

Parameters:

newIconURI - The new URI of the icon, which may be a resource URI.

See Also:

GLYPH_URI_PROPERTY

getLabel

java.lang.String getLabel()

Returns:

The label text, which may include a resource reference, or null if there is no label text.

setLabel

void setLabel(java.lang.String newLabelText)

Sets the text of the label. This is a bound property.

Parameters:

newLabelText - The new text of the label, which may include a resource reference.

See Also:

LABEL_PROPERTY

getLabelContentType

com.globalmentor.net.ContentType getLabelContentType()

Returns:

The content type of the label text.

setLabelContentType

void setLabelContentType(com.globalmentor.net.ContentType newLabelTextContentType)

Sets the content type of the label text. This is a bound property.

Parameters:

newLabelTextContentType - The new label text content type.

Throws:

java.lang.NullPointerException - if the given content type is null.

java.lang.IllegalArgumentException - if the given content type is not a text content type.

See Also:

LABEL_CONTENT_TYPE_PROPERTY