com.guiseframework.model
Class DefaultInfoModel

java.lang.Object
  com.globalmentor.beans.BoundPropertyObject
      com.guiseframework.model.AbstractModel
          com.guiseframework.model.DefaultLabelModel
              com.guiseframework.model.DefaultInfoModel

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractPrototype, Breadcrumb, DefaultTableColumnModel, LocaleInfoModel, ValueConverterInfoModel

public class DefaultInfoModel
extends DefaultLabelModel
implements InfoModel

A default implementation of a model for a label and descriptive information.

Author:

Garret Wilson

Field Summary

Fields inherited from class com.globalmentor.beans.BoundPropertyObject

NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS

Fields inherited from interface com.guiseframework.model.InfoModel

DESCRIPTION_CONTENT_TYPE_PROPERTY, DESCRIPTION_PROPERTY, INFO_CONTENT_TYPE_PROPERTY, INFO_PROPERTY

Fields inherited from interface com.guiseframework.model.LabelModel

GLYPH_URI_PROPERTY, LABEL_CONTENT_TYPE_PROPERTY, LABEL_PROPERTY

Fields inherited from interface com.guiseframework.model.Model

PLAIN_TEXT_CONTENT_TYPE, XHTML_CONTENT_TYPE, XHTML_FRAGMENT_CONTENT_TYPE

Constructor Summary

DefaultInfoModel()
Default constructor.

DefaultInfoModel(java.lang.String label)
Label constructor.

DefaultInfoModel(java.lang.String label, java.net.URI glyphURI)
Label and glyph URI constructor.

Method Summary

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 class com.guiseframework.model.DefaultLabelModel

getGlyphURI, getLabel, getLabelContentType, setGlyphURI, setLabel, setLabelContentType, toString

Methods inherited from class com.guiseframework.model.AbstractModel

getEventListenerManager, getPlainText

Methods inherited from class com.globalmentor.beans.BoundPropertyObject

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.guiseframework.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

Constructor Detail

DefaultInfoModel

public DefaultInfoModel()

Default constructor.

DefaultInfoModel

public DefaultInfoModel(java.lang.String label)

Label constructor.

Parameters:

label - The text of the label, or null if there should be no label.

DefaultInfoModel

public DefaultInfoModel(java.lang.String label,
                        java.net.URI glyphURI)

Label and glyph URI constructor.

Parameters:

label - The text of the label, or null if there should be no label.

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

Method Detail

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface InfoModel

Returns:

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

setDescription

public void setDescription(java.lang.String newDescription)

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

Specified by:

setDescription in interface InfoModel

Parameters:

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

See Also:

InfoModel.DESCRIPTION_PROPERTY

getDescriptionContentType

public com.globalmentor.net.ContentType getDescriptionContentType()

Specified by:

getDescriptionContentType in interface InfoModel

Returns:

The content type of the description text.

setDescriptionContentType

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

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

Specified by:

setDescriptionContentType in interface InfoModel

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:

InfoModel.DESCRIPTION_CONTENT_TYPE_PROPERTY

getInfo

public java.lang.String getInfo()

Specified by:

getInfo in interface InfoModel

Returns:

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

setInfo

public void setInfo(java.lang.String newInfo)

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

Specified by:

setInfo in interface InfoModel

Parameters:

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

See Also:

InfoModel.INFO_PROPERTY

getInfoContentType

public com.globalmentor.net.ContentType getInfoContentType()

Specified by:

getInfoContentType in interface InfoModel

Returns:

The content type of the advisory information text.

setInfoContentType

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

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

Specified by:

setInfoContentType in interface InfoModel

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:

InfoModel.INFO_CONTENT_TYPE_PROPERTY