Package com.github.bordertech.wcomponents

Class WAbbrText

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WBeanComponent

com.github.bordertech.wcomponents.WText

com.github.bordertech.wcomponents.WAbbrText

All Implemented Interfaces:

BeanAware, BeanBound, BeanProviderBound, DataBound, WComponent, WebComponent, Serializable

public class WAbbrText
extends WText

The WAbbrText component represents an abbreviation or acronym and the full textual description for its (abbreviated) text content.

Since:

1.0.0

Author:

Kishan Bisht, Mark Reeves

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.WText

WText.TextModel

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.AbstractWComponent

AbstractWComponent.WComponentRef

Field Summary

Fields inherited from interface com.github.bordertech.wcomponents.WComponent

DEFAULT_APPLICATION_ID, DEFAULT_INTERNAL_ID, DEFAULT_NO_ID, ID_CONTEXT_SEPERATOR, ID_FRAMEWORK_ASSIGNED_SEPERATOR, ID_VALIDATION_PATTERN

Constructor Summary

Constructors

Constructor	Description
WAbbrText()	Creates an empty WAbbrText.
WAbbrText(String text)	Creates a WAbbrText with the specified abbreviated display text.
WAbbrText(String text, String description)	Creates a WAbbrText with the specified abbreviated display text and toolTip full expansion text.

Method Summary

Modifier and Type	Method	Description
String	getAbbrText()	Deprecated. as of WComponents 1.0.0, use AbstractWComponent.getToolTip() instead
void	setAbbrText(String abbrText)	Deprecated. As of WComponents 1.0.0, use AbstractWComponent.setToolTip(String, Serializable...) instead.
void	setTextWithCode(Object entry)	Loads the abbreviated text component from the given code reference table entry using the entry's code as the visible (abbreviated) text and the entry's description as the abbreviation's expanded text toolTip.
void	setTextWithDesc(Object entry)	Loads the abbreviated text component from the given code reference table entry using the entry's description as the visible (abbreviated) text and the entry's code as the toolTip (expansion).
String	toString()	Get a String representation of the component.

Methods inherited from class com.github.bordertech.wcomponents.WText

getComponentModel, getData, getOrCreateComponentModel, getText, isEncodeText, isSanitizeOnOutput, newComponentModel, sanitizeOutputText, setEncodeText, setSanitizeOnOutput, setText

Methods inherited from class com.github.bordertech.wcomponents.WBeanComponent

addBeanToScratchMap, doUpdateBeanValue, getBean, getBeanFromScratchMap, getBeanId, getBeanProperty, getBeanProvider, getBeanScratchMap, getBeanValue, isBeanInScratchMap, isChanged, isSearchAncestors, isUseRequestScopeScratchMap, removeBeanFromScratchMap, resetData, setBean, setBeanId, setBeanProperty, setBeanProvider, setData, setSearchAncestors, updateBeanValue

Methods inherited from class com.github.bordertech.wcomponents.AbstractWComponent

addHtmlClass, addHtmlClass, addNotify, afterPaint, assertAddSupported, beforePaint, createErrorDiagnostic, createErrorDiagnostic, forward, getAccessibleText, getAttribute, getBaseUrl, getDefaultModel, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getScratchMap, getTabIndex, getTag, getTemplate, getTemplateMarkUp, getToolTip, handleRequest, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, paintComponent, preparePaint, preparePaintComponent, removeAttribute, removeComponentModel, removeHtmlClass, removeHtmlClass, removeNotify, replaceWComponent, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFlag, setFocussed, setHidden, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showErrorIndicatorsForComponent, showWarningIndicators, showWarningIndicatorsForComponent, tidyUpUIContext, tidyUpUIContextForTree, validate, validateComponent, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

WAbbrText

public WAbbrText()

Creates an empty WAbbrText.

An instance of WAbbrText created in this manner must have abbreviated display text and a toolTip (the full text represented by the abbreviation) set to be useful.

WAbbrText

public WAbbrText(String text)

Creates a WAbbrText with the specified abbreviated display text.

An instance of WAbbrText created in this manner must have a toolTip (the full text represented by the abbreviation) set to be useful.

Parameters:

text - The abbreviated text to display

WAbbrText

public WAbbrText(String text,
                 String description)

Creates a WAbbrText with the specified abbreviated display text and toolTip full expansion text.

Parameters:

text - the abbreviated text to display

description - the full text represented by the abbreviation

Method Detail

getAbbrText

public String getAbbrText()

Deprecated.

as of WComponents 1.0.0, use AbstractWComponent.getToolTip() instead

Returns:

the expanded text represented by the abbreviation

setTextWithCode

public void setTextWithCode(Object entry)

Loads the abbreviated text component from the given code reference table entry using the entry's code as the visible (abbreviated) text and the entry's description as the abbreviation's expanded text toolTip.

Parameters:

entry - the CRT entry to use.

setAbbrText

public void setAbbrText(String abbrText)

Deprecated.

As of WComponents 1.0.0, use AbstractWComponent.setToolTip(String, Serializable...) instead.

Sets the full text represented by the abbreviation.

Parameters:

abbrText - the full text (expansion) represented by the abbreviation

setTextWithDesc

public void setTextWithDesc(Object entry)

Loads the abbreviated text component from the given code reference table entry using the entry's description as the visible (abbreviated) text and the entry's code as the toolTip (expansion). You probably do not want this: you probably want setTextWithCode(java.lang.Object).

Parameters:

entry - the CRT entry to use

toString

public String toString()

Get a String representation of the component. This would normally only be required for debugging purposes.

Overrides:

toString in class WText

Returns:

a String representation of this component