Package io.guise.framework.model

Interface InfoModel

All Superinterfaces:

LabelModel, 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, InputFocusableComponent, InputFocusGroupComponent, LabelComponent, LabelDisplayableComponent, LayoutComponent, LayoutControl, LinkControl, ListSelectControl<V>, Menu, ModalComponent<M>, ModalFrame<R>, ModalNavigationPanel<R>, NavigationComponent, OptionDialogFrame<O>, Panel, PendingImageComponent, SectionComponent, SelectActionControl, SelectButtonControl, SelectControl<V>, SelectLinkControl, TableColumnModel<V>, ToolButtonControl, 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, AutoNavigationPathBreadcrumbLinkPanel, BooleanSelectButton, BooleanSelectLink, BooleanSelectToolButton, BooleanValueControlSelectControl, Breadcrumb, BusyPanel, Button, CalendarControl, CalendarDialogFrame, CalendarMonthTableModel.WeekDayTableColumnModel, CardConstraints, CardPanel, CardTabControl, CheckControl, DateTimeControl, DateTimeFieldsControl, DefaultApplicationFrame, DefaultDialogFrame, DefaultFlyoverFrame, DefaultFrame, DefaultInfoModel, DefaultModalFrame, DefaultModalNavigationPanel, DefaultTableColumnModel, DropMenu, EditComponentLabelControl, EditComponentTextControl, Flash, GroupPanel, Heading, HeadingLink, Image, ImageActionControl, ImageBooleanSelectActionControl, Label, LabelPrototype, LayoutPanel, LikeButton, Link, ListControl, LocaleInfoModel, MenuPrototype, Message, MessageOptionDialogFrame, NamePanel, NavigateActionPrototype, NavigationPathBreadcrumbLinkPanel, NotificationOptionDialogFrame, PasswordAuthenticationPanel, PendingImage, PendingImageActionControl, Picture, PlatformFileUploadPanel, ProxyActionPrototype, ResourceCollectControl, ResourceImportControl, ScrollControl, SectionPanel, SelectableLabel, SelectButton, SelectLink, SequenceCardPanel, SliderControl, SpinnerControl, TabbedPanel, TabContainerControl, TabControl, Table, Table.DefaultCellMessage, TaskCardConstraints, TaskStateSelectLink, TextBox, TextControl, TogglePrototype, Toolbar, ToolButton, TreeControl, ValueConverterInfoModel, ValuePrototype, ValueSelectButton, ValueSelectLink

public interface InfoModel
extends LabelModel

A model for a label and descriptive information.

Author:

Garret Wilson

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DESCRIPTION_CONTENT_TYPE_PROPERTY	The description content type bound property.
static java.lang.String	DESCRIPTION_PROPERTY	The description bound property.
static java.lang.String	INFO_CONTENT_TYPE_PROPERTY	The info content type bound property.
static java.lang.String	INFO_PROPERTY	The info bound property.

Fields inherited from interface io.guise.framework.model.LabelModel

GLYPH_URI_PROPERTY, LABEL_CONTENT_TYPE_PROPERTY, LABEL_PROPERTY

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()
com.globalmentor.net.ContentType	getDescriptionContentType()
java.lang.String	getInfo()
com.globalmentor.net.ContentType	getInfoContentType()
void	setDescription(java.lang.String newDescription)	Sets the description text, such as might appear in a flyover.
void	setDescriptionContentType(com.globalmentor.net.ContentType newDescriptionContentType)	Sets the content type of the description text.
void	setInfo(java.lang.String newInfo)	Sets the advisory information text, such as might appear in a tooltip.
void	setInfoContentType(com.globalmentor.net.ContentType newInfoContentType)	Sets the content type of the advisory information text.

Methods inherited from interface io.guise.framework.model.LabelModel

getGlyphURI, getLabel, getLabelContentType, setGlyphURI, setLabel, setLabelContentType

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

DESCRIPTION_PROPERTY

static final java.lang.String DESCRIPTION_PROPERTY

The description bound property.

DESCRIPTION_CONTENT_TYPE_PROPERTY

static final java.lang.String DESCRIPTION_CONTENT_TYPE_PROPERTY

The description content type bound property.

INFO_PROPERTY

static final java.lang.String INFO_PROPERTY

The info bound property.

INFO_CONTENT_TYPE_PROPERTY

static final java.lang.String INFO_CONTENT_TYPE_PROPERTY

The info content type bound property.

Method Detail

getDescription

java.lang.String getDescription()

Returns:

The description text, such as might appear in a flyover, or null if there is no description.

setDescription

void setDescription(java.lang.String newDescription)

Sets the description text, such as might appear in a flyover. This is a bound property.

Parameters:

newDescription - The new text of the description, such as might appear in a flyover.

See Also:

DESCRIPTION_PROPERTY

getDescriptionContentType

com.globalmentor.net.ContentType getDescriptionContentType()

Returns:

The content type of the description text.

setDescriptionContentType

void setDescriptionContentType(com.globalmentor.net.ContentType newDescriptionContentType)

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

Parameters:

newDescriptionContentType - The new description 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:

DESCRIPTION_CONTENT_TYPE_PROPERTY

getInfo

java.lang.String getInfo()

Returns:

The advisory information text, such as might appear in a tooltip, or null if there is no advisory information.

setInfo

void setInfo(java.lang.String newInfo)

Sets the advisory information text, such as might appear in a tooltip. This is a bound property.

Parameters:

newInfo - The new text of the advisory information, such as might appear in a tooltip.

See Also:

INFO_PROPERTY

getInfoContentType

com.globalmentor.net.ContentType getInfoContentType()

Returns:

The content type of the advisory information text.

setInfoContentType

void setInfoContentType(com.globalmentor.net.ContentType newInfoContentType)

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

Parameters:

newInfoContentType - The new advisory information 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:

INFO_CONTENT_TYPE_PROPERTY