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>, 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, DefaultLabelModel, 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, Notification, 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 LabelModel extends Model
A model for an identifier such as text and/or an icon.
Author:
Garret Wilson
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    The icon bound property.
    static final String
    The label content type bound property.
    static final String
    The label bound property.
  • Method Summary

    Modifier and Type
    Method
    Description
     
     
    com.globalmentor.net.MediaType
     
    void
    setGlyphURI(URI newIcon)
    Sets the URI of the icon.
    void
    setLabel(String newLabelText)
    Sets the text of the label.
    void
    setLabelContentType(com.globalmentor.net.MediaType 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 Details

    • GLYPH_URI_PROPERTY

      static final String GLYPH_URI_PROPERTY
      The icon bound property.
    • LABEL_PROPERTY

      static final String LABEL_PROPERTY
      The label bound property.
    • LABEL_CONTENT_TYPE_PROPERTY

      static final String LABEL_CONTENT_TYPE_PROPERTY
      The label content type bound property.
  • Method Details

    • getGlyphURI

      URI getGlyphURI()
      Returns:
      The glyph URI, which may be a resource URI, or null if there is no glyph URI.
    • setGlyphURI

      void setGlyphURI(URI newIcon)
      Sets the URI of the icon. This is a bound property.
      Parameters:
      newIcon - The new URI of the icon, which may be a resource URI.
      See Also:
    • getLabel

      String getLabel()
      Returns:
      The label text, which may include a resource reference, or null if there is no label text.
    • setLabel

      void setLabel(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:
    • getLabelContentType

      com.globalmentor.net.MediaType getLabelContentType()
      Returns:
      The content type of the label text.
    • setLabelContentType

      void setLabelContentType(com.globalmentor.net.MediaType newLabelTextContentType)
      Sets the content type of the label text. This is a bound property.
      Parameters:
      newLabelTextContentType - The new label text content type.
      Throws:
      NullPointerException - if the given content type is null.
      IllegalArgumentException - if the given content type is not a text content type.
      See Also: