public class

LabelBase

extends Widget
implements HasDirectionEstimator HasAutoHorizontalAlignment HasWordWrap

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.client.ui.LabelBase<T>

Known Direct Subclasses

Label, ValueLabel<T>

Known Indirect Subclasses

DateLabel, HTML, InlineHTML, InlineLabel, NumberLabel<T extends Number>

Class Overview

Abstract base class for all text display widgets.

Use in UiBinder Templates

Summary

[Expand]

Inherited Constants

From class com.google.gwt.user.client.ui.UIObject

[Expand]

Inherited Fields

From interface com.google.gwt.user.client.ui.HasAutoHorizontalAlignment

From interface com.google.gwt.user.client.ui.HasHorizontalAlignment

Protected Constructors
	LabelBase(boolean inline)
	LabelBase(Element element)

Public Methods
HasHorizontalAlignment.AutoHorizontalAlignmentConstant	getAutoHorizontalAlignment() Gets the horizontal auto-alignment setting.
DirectionEstimator	getDirectionEstimator() Returns the `DirectionEstimator` object.
HasHorizontalAlignment.HorizontalAlignmentConstant	getHorizontalAlignment() Gets the horizontal alignment.
boolean	getWordWrap() Gets whether word-wrapping is enabled.
void	setAutoHorizontalAlignment(HasHorizontalAlignment.AutoHorizontalAlignmentConstant autoAlignment) Sets the horizontal alignment, allowing in addition to the "static" `HasHorizontalAlignment.HorizontalAlignmentConstant` values, the "automatic" `HasHorizontalAlignment.AutoHorizontalAlignmentConstant` values that depend on the content direction.
void	setDirectionEstimator(DirectionEstimator directionEstimator) Sets the `DirectionEstimator` object. Note: DirectionEstimator should be set before the widget has any content; it's highly recommended to set it using a constructor.
void	setDirectionEstimator(boolean enabled) Toggles on / off direction estimation. See note at `setDirectionEstimator(DirectionEstimator)`.
void	setHorizontalAlignment(HasHorizontalAlignment.HorizontalAlignmentConstant align) Sets the horizontal alignment. Note: A subsequent call to `setAutoHorizontalAlignment(HasHorizontalAlignment.AutoHorizontalAlignmentConstant)` may override the horizontal alignment set by this method.
void	setWordWrap(boolean wrap) Sets whether word-wrapping is enabled.

Protected Methods
void	updateHorizontalAlignment() Sets the horizontal alignment of the widget according to the current AutoHorizontalAlignment setting.

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.Widget

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

From class com.google.gwt.user.client.ui.UIObject

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.i18n.shared.HasDirectionEstimator

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.ui.HasAutoHorizontalAlignment

From interface com.google.gwt.user.client.ui.HasHorizontalAlignment

From interface com.google.gwt.user.client.ui.HasWordWrap

From interface com.google.gwt.user.client.ui.IsWidget

Protected Constructors

protected LabelBase (boolean inline)

protected LabelBase (Element element)

Public Methods

public HasHorizontalAlignment.AutoHorizontalAlignmentConstant getAutoHorizontalAlignment ()

Gets the horizontal auto-alignment setting. This may be one of the auto-alignment values above that depend on content direction (e.g. ALIGN_CONTENT_START), or one of the "static" HasHorizontalAlignment.HorizontalAlignmentConstant alignment values (e.g. ALIGN_LOCALE_START). It may be set by either setAutoHorizontalAlignment or HasHorizontalAlignment#setHorizontalAlignment. The default is null, indicating that no specific horizontal alignment has been set, allowing it to be determined by the usual HTML and CSS mechanisms.

Returns

the current automatic horizontal alignment policy.

public DirectionEstimator getDirectionEstimator ()

Returns the DirectionEstimator object.

public HasHorizontalAlignment.HorizontalAlignmentConstant getHorizontalAlignment ()

Gets the horizontal alignment.

Returns

the current horizontal alignment ( ALIGN_LEFT, ALIGN_CENTER, ALIGN_RIGHT, ALIGN_JUSTIFY, or null).

public boolean getWordWrap ()

Gets whether word-wrapping is enabled.

Returns

true if word-wrapping is enabled.

public void setAutoHorizontalAlignment (HasHorizontalAlignment.AutoHorizontalAlignmentConstant autoAlignment)

Sets the horizontal alignment, allowing in addition to the "static" HasHorizontalAlignment.HorizontalAlignmentConstant values, the "automatic" HasHorizontalAlignment.AutoHorizontalAlignmentConstant values that depend on the content direction. Determines the values returned by both getAutoHorizontalAlignment() and getHorizontalAlignment().

For the ALIGN_CONTENT_START and ALIGN_CONTENT_END values, sets the horizontal alignment (including the value of HasHorizontalAlignment#getHorizontalAlignment()) to the start or end edge of the current content's direction, respectively, and continues to automatically update it whenever the content direction changes.

For other values, operates like setHorizontalAlignment(HasHorizontalAlignment.HorizontalAlignmentConstant).

For null, the horizontal alignment is cleared, allowing it to be determined by the standard HTML mechanisms such as inheritance and CSS rules.

Parameters

autoAlignment	the new automatic horizontal alignment policy

public void setDirectionEstimator (DirectionEstimator directionEstimator)

Sets the DirectionEstimator object.

Note: DirectionEstimator should be set before the widget has any content; it's highly recommended to set it using a constructor. Reason: if the widget already has non-empty content, this will update its direction according to the new estimator's result. This may cause flicker, and thus should be avoided.

Parameters

directionEstimator	The {code DirectionEstimator} to be set. `null` means turning off direction estimation.

public void setDirectionEstimator (boolean enabled)

Toggles on / off direction estimation.

See note at setDirectionEstimator(DirectionEstimator).

Parameters

enabled	Whether to enable direction estimation. If `true`, sets the `DirectionEstimator` object to a default `DirectionEstimator`.

public void setHorizontalAlignment (HasHorizontalAlignment.HorizontalAlignmentConstant align)

Sets the horizontal alignment.

Use null to clear horizontal alignment, allowing it to be determined by the standard HTML mechanisms such as inheritance and CSS rules.

Note: A subsequent call to setAutoHorizontalAlignment(HasHorizontalAlignment.AutoHorizontalAlignmentConstant) may override the horizontal alignment set by this method.

Note: For null, the horizontal alignment is cleared, allowing it to be determined by the standard HTML mechanisms such as inheritance and CSS rules.

Parameters

align	the horizontal alignment ( `ALIGN_LEFT`, `ALIGN_CENTER`, `ALIGN_RIGHT`, `ALIGN_JUSTIFY`, `ALIGN_LOCALE_START`, or `ALIGN_LOCALE_END`).

public void setWordWrap (boolean wrap)

Sets whether word-wrapping is enabled.

Parameters

wrap	`true` to enable word-wrapping.

Protected Methods

protected void updateHorizontalAlignment ()

Sets the horizontal alignment of the widget according to the current AutoHorizontalAlignment setting. Should be invoked whenever the horizontal alignment may be affected, i.e. on every modification of the content or its direction.

Interfaces

Classes

Annotations

Enums

Exceptions

LabelBase

Class Overview

Use in UiBinder Templates

Summary

Protected Constructors

protected LabelBase (boolean inline)

protected LabelBase (Element element)

Public Methods

public HasHorizontalAlignment.AutoHorizontalAlignmentConstant getAutoHorizontalAlignment ()

Returns

public DirectionEstimator getDirectionEstimator ()

public HasHorizontalAlignment.HorizontalAlignmentConstant getHorizontalAlignment ()

Returns

public boolean getWordWrap ()

Returns

public void setAutoHorizontalAlignment (HasHorizontalAlignment.AutoHorizontalAlignmentConstant autoAlignment)

Parameters

public void setDirectionEstimator (DirectionEstimator directionEstimator)

Parameters

public void setDirectionEstimator (boolean enabled)

Parameters

public void setHorizontalAlignment (HasHorizontalAlignment.HorizontalAlignmentConstant align)

Parameters

See Also

public void setWordWrap (boolean wrap)

Parameters

Protected Methods

protected void updateHorizontalAlignment ()