API Reference 0.3.24dart_web_toolkit_uiInlineHtml

InlineHtml class

A widget that can contain arbitrary HTML.

This widget uses a <span> element, causing it to be displayed with inline layout.

If you only need a simple label (text, but not HTML), then the {@link com.google.gwt.user.client.ui.Label} widget is more appropriate, as it disallows the use of HTML, which can lead to potential security issues if not used properly.

Built-in Bidi Text Support

This widget is capable of automatically adjusting its direction according to its content. This feature is controlled by {@link #setDirectionEstimator} or passing a DirectionEstimator parameter to the constructor, and is off by default.

CSS Style Rules

  • .gwt-InlineHTML { }
class InlineHtml extends Html {

 /**
  * Creates an InlineHTML widget that wraps an existing &lt;div&gt; or
  * &lt;span&gt; element.
  *
  * This element must already be attached to the document. If the element is
  * removed from the document, you must call
  * {@link RootPanel#detachNow(Widget)}.
  *
  * @param element the element to be wrapped
  */
 factory InlineHtml.wrap(dart_html.Element element) {
   // Assert that the element is attached.
   //assert Document.get().getBody().isOrHasChild(element);

   InlineHtml html = new InlineHtml.fromElement(element);

   // Mark it attached and remember it for cleanup.
   html.onAttach();
   RootPanel.detachOnWindowClose(html);

   return html;
 }

 /**
  * This constructor may be used by subclasses to explicitly use an existing
  * element. This element must be either a div or span element.
  */
 InlineHtml.fromElement(dart_html.Element element) : super.fromElement(element) {
   clearAndSetStyleName("dwt-InlineHTML");
 }

 /**
  * Creates an HTML widget with the specified HTML contents.
  */
 InlineHtml([String html = null]) : super.fromElement(new dart_html.SpanElement()) {
   clearAndSetStyleName("dwt-InlineHTML");
   if (html != null) {
     this.html = html;
   }
 }
}

Extends

UiObject > Widget > LabelBase<String> > Label > Html > InlineHtml

Constructors

new InlineHtml([String html = null]) #

Creates an HTML widget with the specified HTML contents.

InlineHtml([String html = null]) : super.fromElement(new dart_html.SpanElement()) {
 clearAndSetStyleName("dwt-InlineHTML");
 if (html != null) {
   this.html = html;
 }
}

new InlineHtml.fromElement(Element element) #

This constructor may be used by subclasses to explicitly use an existing element. This element must be either a div or span element.

InlineHtml.fromElement(dart_html.Element element) : super.fromElement(element) {
 clearAndSetStyleName("dwt-InlineHTML");
}

factory InlineHtml.wrap(Element element) #

Creates an InlineHTML widget that wraps an existing <div> or <span> element.

This element must already be attached to the document. If the element is removed from the document, you must call {@link RootPanel#detachNow(Widget)}.

@param element the element to be wrapped

factory InlineHtml.wrap(dart_html.Element element) {
 // Assert that the element is attached.
 //assert Document.get().getBody().isOrHasChild(element);

 InlineHtml html = new InlineHtml.fromElement(element);

 // Mark it attached and remember it for cleanup.
 html.onAttach();
 RootPanel.detachOnWindowClose(html);

 return html;
}

Properties

DirectionalTextHelper directionalTextHelper #

inherited from LabelBase

The widget's DirectionalTextHelper object.

DirectionalTextHelper directionalTextHelper

int eventsToSink #

inherited from Widget

A set og events that should be sunk when the widget is attached to the DOM. (We delay the sinking of events to improve startup performance.) When the widget is attached, this is set is empty

Package protected to allow Composite to see it.

int eventsToSink = 0

String get html #

inherited from Html

Gets this object's contents as HTML.

@return the object's HTML

docs inherited from HasHtml
String get html => directionalTextHelper.getTextOrHtml(true);

void set html(String val) #

inherited from Html

Sets the label's content to the given HTML. See {@link #setText(String)} for details on potential effects on direction and alignment.

@param html the new widget's HTML content

void set html(String val) {
 directionalTextHelper.setTextOrHtml(val, true);
 updateHorizontalAlignment();
}

String get text #

inherited from Label

Gets this object's text.

@return the object's text

docs inherited from HasText
String get text => directionalTextHelper.getTextOrHtml(false);

void set text(String val) #

inherited from Label

Sets the label's content to the given text. <p> Doesn't change the widget's direction or horizontal alignment if {@code directionEstimator} is null. Otherwise, the widget's direction is set using the estimator, and its alignment may therefore change as described in {@link #setText(String, com.google.gwt.i18n.client.HasDirection.Direction) setText(String, Direction)}.

@param text the widget's new text

void set text(String val) {
 directionalTextHelper.setTextOrHtml(val, false);
 updateHorizontalAlignment();
}

String get title #

inherited from UiObject

Gets the title associated with this object. The title is the 'tool-tip' displayed to users when they hover over the object.

@return the object's title

String get title => getElement().title;

void set title(String value) #

inherited from UiObject

Sets the element's title.

void set title(String value) {
 getElement().title = value;
}

bool get visible #

inherited from UiObject

Determines whether or not this object is visible. Note that this does not necessarily take into account whether or not the receiver's parent is visible, or even if it is attached to the Document. The default implementation of this trait in UIObject is based on the value of a dom element's style object's display attribute.

@return <code>true</code> if the object is visible

bool get visible => isVisible(getElement());

void set visible(bool visible) #

inherited from UiObject

Sets whether this object is visible.

@param visible <code>true</code> to show the object, <code>false</code> to

     hide it
void set visible(bool visible) {
 setVisible(getElement(), visible);
}

bool get wordWrap #

inherited from LabelBase

Gets whether word-wrapping is enabled.

@return <code>true</code> if word-wrapping is enabled.

docs inherited from HasWordWrap
bool get wordWrap => WhiteSpace.NOWRAP.value == getElement().style.whiteSpace;

void set wordWrap(bool wrap) #

inherited from LabelBase

Sets whether word-wrapping is enabled.

@param wrap <code>true</code> to enable word-wrapping.

docs inherited from HasWordWrap
void set wordWrap(bool wrap) {
 getElement().style.whiteSpace = wrap ? WhiteSpace.NORMAL.value : WhiteSpace.NOWRAP.value;
}

Methods

HandlerRegistration addAttachHandler(AttachEventHandler handler) #

inherited from Widget

Adds an AttachEvent handler.

@param handler the handler @return the handler registration

HandlerRegistration addAttachHandler(AttachEventHandler handler) {
 return addHandler(handler, AttachEvent.TYPE);
}

HandlerRegistration addBitlessDomHandler(EventHandler handler, DomEventType type) #

inherited from Widget

For <a href= "http://code.google.com/p/google-web-toolkit/wiki/UnderstandingMemoryLeaks"

browsers which do not leak</a>, adds a native event handler to the widget.

Note that, unlike the {@link #addDomHandler(EventHandler, com.google.gwt.event.dom.client.DomEvent.Type)} implementation, there is no need to attach the widget to the DOM in order to cause the event handlers to be attached.

@param <H> the type of handler to add @param type the event key @param handler the handler @return {@link HandlerRegistration} used to remove the handler

HandlerRegistration addBitlessDomHandler(EventHandler handler, DomEventType type) {
 assert (handler != null);; // : "handler must not be null";
 assert (type != null); // : "type must not be null";
 sinkBitlessEvent(type.eventName);
 return ensureHandlers().addHandler(type, handler);
}

HandlerRegistration addClickHandler(ClickHandler handler) #

inherited from Label

Adds a {@link ClickEvent} handler.

@param handler the click handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasClickHandlers
HandlerRegistration addClickHandler(ClickHandler handler) {
 return addDomHandler(handler, ClickEvent.TYPE);
}

HandlerRegistration addDomHandler(EventHandler handler, DomEventType type) #

inherited from Widget

Adds a native event handler to the widget and sinks the corresponding native event. If you do not want to sink the native event, use the generic addHandler method instead.

@param <H> the type of handler to add @param type the event key @param handler the handler @return {@link HandlerRegistration} used to remove the handler

HandlerRegistration addDomHandler(EventHandler handler, DomEventType type) {
 assert (handler != null); // : "handler must not be null";
 assert (type != null); // : "type must not be null";
 int typeInt = IEvent.getTypeInt(type.eventName);
 if (typeInt == -1) {
   sinkBitlessEvent(type.eventName);
 } else {
   sinkEvents(typeInt);
 }
 return ensureHandlers().addHandler(type, handler);
}

HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler) #

inherited from Label

Adds a {@link DoubleClickEvent} handler.

@param handler the double click handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDoubleClickHandlers
HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler) {
 return addDomHandler(handler, DoubleClickEvent.TYPE);
}

HandlerRegistration addDragEndHandler(DragEndHandler handler) #

inherited from Label

Adds a {@link DragEndEvent} handler.

@param handler the drag end handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragEndHandlers
HandlerRegistration addDragEndHandler(DragEndHandler handler) {
 return addDomHandler(handler, DragEndEvent.TYPE);
}

HandlerRegistration addDragEnterHandler(DragEnterHandler handler) #

inherited from Label

Adds a {@link DragEnterEvent} handler.

@param handler the drag end handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragEnterHandlers
HandlerRegistration addDragEnterHandler(DragEnterHandler handler) {
 return addDomHandler(handler, DragEnterEvent.TYPE);
}

HandlerRegistration addDragHandler(DragHandler handler) #

inherited from Label

Adds a {@link DragEvent} handler.

@param handler the drag handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragHandlers
HandlerRegistration addDragHandler(DragHandler handler) {
 return addDomHandler(handler, DragEvent.TYPE);
}

HandlerRegistration addDragLeaveHandler(DragLeaveHandler handler) #

inherited from Label

Adds a {@link DragLeaveEvent} handler.

@param handler the drag leave handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragLeaveHandlers
HandlerRegistration addDragLeaveHandler(DragLeaveHandler handler) {
 return addDomHandler(handler, DragLeaveEvent.TYPE);
}

HandlerRegistration addDragOverHandler(DragOverHandler handler) #

inherited from Label

Adds a {@link DragOverEvent} handler.

@param handler the drag over handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragOverHandlers
HandlerRegistration addDragOverHandler(DragOverHandler handler) {
 return addDomHandler(handler, DragOverEvent.TYPE);
}

HandlerRegistration addDragStartHandler(DragStartHandler handler) #

inherited from Label

Adds a {@link DragStartEvent} handler.

@param handler the drag start handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDragStartHandlers
HandlerRegistration addDragStartHandler(DragStartHandler handler) {
 return addDomHandler(handler, DragStartEvent.TYPE);
}

HandlerRegistration addDropHandler(DropHandler handler) #

inherited from Label

Adds a {@link DropEvent} handler.

@param handler the drop handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasDropHandlers
HandlerRegistration addDropHandler(DropHandler handler) {
 return addDomHandler(handler, DropEvent.TYPE);
}

HandlerRegistration addHandler(EventHandler handler, EventType<EventHandler> type) #

inherited from Widget

Adds this handler to the widget.

@param <H> the type of handler to add @param type the event type @param handler the handler @return {@link HandlerRegistration} used to remove the handler

HandlerRegistration addHandler(EventHandler handler, EventType<EventHandler> type) {
 return ensureHandlers().addHandler(type, handler);
}

HandlerRegistration addMouseDownHandler(MouseDownHandler handler) #

inherited from Label

Adds a {@link MouseDownEvent} handler.

@param handler the mouse down handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseDownHandlers
HandlerRegistration addMouseDownHandler(MouseDownHandler handler) {
 return addDomHandler(handler, MouseDownEvent.TYPE);
}

HandlerRegistration addMouseMoveHandler(MouseMoveHandler handler) #

inherited from Label

Adds a {@link MouseMoveEvent} handler.

@param handler the mouse move handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseMoveHandlers
HandlerRegistration addMouseMoveHandler(MouseMoveHandler handler) {
 return addDomHandler(handler, MouseMoveEvent.TYPE);
}

HandlerRegistration addMouseOutHandler(MouseOutHandler handler) #

inherited from Label

Adds a {@link MouseOutEvent} handler.

@param handler the mouse out handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseOutHandlers
HandlerRegistration addMouseOutHandler(MouseOutHandler handler) {
 return addDomHandler(handler, MouseOutEvent.TYPE);
}

HandlerRegistration addMouseOverHandler(MouseOverHandler handler) #

inherited from Label

Adds a {@link MouseOverEvent} handler.

@param handler the mouse over handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseOverHandlers
HandlerRegistration addMouseOverHandler(MouseOverHandler handler) {
 return addDomHandler(handler, MouseOverEvent.TYPE);
}

HandlerRegistration addMouseUpHandler(MouseUpHandler handler) #

inherited from Label

Adds a {@link MouseUpEvent} handler.

@param handler the mouse up handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseUpHandlers
HandlerRegistration addMouseUpHandler(MouseUpHandler handler) {
 return addDomHandler(handler, MouseUpEvent.TYPE);
}

HandlerRegistration addMouseWheelHandler(MouseWheelHandler handler) #

inherited from Label

Adds a {@link MouseWheelEvent} handler.

@param handler the mouse wheel handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasMouseWheelHandlers
HandlerRegistration addMouseWheelHandler(MouseWheelHandler handler) {
 return addDomHandler(handler, MouseWheelEvent.TYPE);
}

void addStyleDependentName(String styleSuffix) #

inherited from UiObject

Adds a dependent style name by specifying the style name's suffix. The actual form of the style name that is added is:

getStylePrimaryName() + '-' + styleSuffix

@param styleSuffix the suffix of the dependent style to be added. @see #setStylePrimaryName(String) @see #removeStyleDependentName(String) @see #setStyleDependentName(String, boolean) @see #addStyleName(String)

void addStyleDependentName(String styleSuffix) {
 setStyleDependentName(styleSuffix, true);
}

void addStyleName(String style) #

inherited from UiObject

Adds a secondary or dependent style name to this object. A secondary style name is an additional style name that is, in HTML/CSS terms, included as a space-separated token in the value of the CSS <code>class</code> attribute for this object's root element.

The most important use for this method is to add a special kind of secondary style name called a dependent style name. To add a dependent style name, use {@link #addStyleDependentName(String)}, which will prefix the 'style' argument with the result of {@link #k()} (followed by a '-'). For example, suppose the primary style name is gwt-TextBox. If the following method is called as obj.setReadOnly(true):

public void setReadOnly(boolean readOnly) {
  isReadOnlyMode = readOnly;

// Create a dependent style name. String readOnlyStyle = "readonly";

if (readOnly) {

addStyleDependentName(readOnlyStyle);

} else {

removeStyleDependentName(readOnlyStyle);

} }</pre>

then both of the CSS style rules below will be applied:

// This rule is based on the primary style name and is always active. .gwt-TextBox { font-size: 12pt; }

// This rule is based on a dependent style name that is only active // when the widget has called addStyleName(getStylePrimaryName() + // "-readonly"). .gwt-TextBox-readonly { background-color: lightgrey; border: none; }</pre>

The code can also be simplified with {@link #setStyleDependentName(String, boolean)}:

public void setReadOnly(boolean readOnly) {
  isReadOnlyMode = readOnly;
  setStyleDependentName("readonly", readOnly);
}

Dependent style names are powerful because they are automatically updated whenever the primary style name changes. Continuing with the example above, if the primary style name changed due to the following call:

setStylePrimaryName("my-TextThingy");

then the object would be re-associated with following style rules, removing those that were shown above.

.my-TextThingy {
  font-size: 20pt;
}

.my-TextThingy-readonly { background-color: red; border: 2px solid yellow; }</pre>

Secondary style names that are not dependent style names are not automatically updated when the primary style name changes.

@param style the secondary style name to be added @see UIObject @see #removeStyleName(String)

void addStyleName(String style) {
 setStyleName(style, true);
}

HandlerRegistration addTouchCancelHandler(TouchCancelHandler handler) #

inherited from Label

Adds a {@link TouchCancelEvent} handler.

@param handler the touch cancel handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasTouchCancelHandlers
HandlerRegistration addTouchCancelHandler(TouchCancelHandler handler) {
 return addDomHandler(handler, TouchCancelEvent.TYPE);
}

HandlerRegistration addTouchEndHandler(TouchEndHandler handler) #

inherited from Label

Adds a {@link TouchEndEvent} handler.

@param handler the touch end handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasTouchEndHandlers
HandlerRegistration addTouchEndHandler(TouchEndHandler handler) {
 return addDomHandler(handler, TouchEndEvent.TYPE);
}

HandlerRegistration addTouchMoveHandler(TouchMoveHandler handler) #

inherited from Label

Adds a {@link TouchMoveEvent} handler.

@param handler the touch move handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasTouchMoveHandlers
HandlerRegistration addTouchMoveHandler(TouchMoveHandler handler) {
 return addDomHandler(handler, TouchMoveEvent.TYPE);
}

HandlerRegistration addTouchStartHandler(TouchStartHandler handler) #

inherited from Label

Adds a {@link TouchStartEvent} handler.

@param handler the touch start handler @return {@link HandlerRegistration} used to remove this handler

docs inherited from HasTouchStartHandlers
HandlerRegistration addTouchStartHandler(TouchStartHandler handler) {
 return addDomHandler(handler, TouchStartEvent.TYPE);
}

LeafValueEditor<String> asEditor() #

inherited from Label
LeafValueEditor<String> asEditor() {
 if (_editor == null) {
   _editor = new HasTextEditor.of(this);
 }
 return _editor;
}

Widget asWidget() #

inherited from Widget

Returns the Widget aspect of the receiver.

Widget asWidget() {
 return this;
}

void clearAndSetStyleName(String style) #

inherited from UiObject

Clears all of the object's style names and sets it to the given style. You should normally use {@link #setStylePrimaryName(String)} unless you wish to explicitly remove all existing styles.

@param style the new style name @see #setStylePrimaryName(String)

void clearAndSetStyleName(String style) {
 setElementStyleName(getStyleElement(), style);
}

EventBus createEventBus() #

inherited from Widget

Creates the SimpleEventBus used by this Widget. You can override this method to create a custom EventBus.

@return the EventBus you want to use.

EventBus createEventBus() {
 return new SimpleEventBus();
}

void delegateEvent(Widget target, DwtEvent event) #

inherited from Widget

Fires an event on a child widget. Used to delegate the handling of an event from one widget to another.

@param event the event @param target fire the event on the given target

void delegateEvent(Widget target, DwtEvent event) {
 target.fireEvent(event);
}

void doAttachChildren() #

inherited from Widget

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 {@link #onAttach()} for each of its child widgets.

@see #onAttach()

void doAttachChildren() {
}

void doDetachChildren() #

inherited from Widget

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 {@link #onDetach()} for each of its child widgets.

@see #onDetach()

void doDetachChildren() {
}

void enableDefaultDirectionEstimator(bool enabled) #

inherited from LabelBase

Toggles on / off direction estimation.

@param enabled Whether to enable direction estimation. If {@code true},

     sets the {@link DirectionEstimator} object to a default
     {@code DirectionEstimator}.
void enableDefaultDirectionEstimator(bool enabled) {
 directionalTextHelper.enableDefaultDirectionEstimator(enabled);
 updateHorizontalAlignment();
}

EventBus ensureHandlers() #

inherited from Widget

Ensures the existence of the event bus.

@return the EventBus.

EventBus ensureHandlers() {
 return _eventBus == null ? _eventBus = createEventBus() : _eventBus;
}

double extractLengthValue(String s) #

inherited from UiObject

Intended to be used to pull the value out of a CSS length. If the value is "auto" or "inherit", 0 will be returned.

@param s The CSS length string to extract @return The leading numeric portion of <code>s</code>, or 0 if "auto" or

    "inherit" are passed in.
double extractLengthValue(String s) {
 if (s == "auto" || s == "inherit" || s == "") {
   return 0.0;
 } else {
   // numberRegex divides the string into a leading numeric portion
   // followed by an arbitrary portion.
   if(numberRegex.hasMatch(s)) {
     // Extract the leading numeric portion of string
     s = numberRegex.firstMatch(s)[0];
   }
   return double.parse(s);
 }
}

void fireEvent(DwtEvent event) #

inherited from Widget

Fires the given event to the handlers listening to the event's type.

Any exceptions thrown by handlers will be bundled into a UmbrellaException and then re-thrown after all handlers have completed. An exception thrown by a handler will not prevent other handlers from executing.

@param event the event

void fireEvent(DwtEvent event) {
//    if (_eventBus != null) {
//      _eventBus.fireEvent(event);
//    }
 if (_eventBus != null) {
   // If it not live we should revive it.
   if (!event.isLive()) {
     event.revive();
   }
   Object oldSource = event.getSource();
   event.overrideSource(getElement());
   try {

     // May throw an UmbrellaException.
     _eventBus.fireEventFromSource(event, getElement());
   } on UmbrellaException catch (e) {
     throw new UmbrellaException(e.causes);
   } finally {
     if (oldSource == null) {
       // This was my event, so I should kill it now that I'm done.
       event.kill();
     } else {
       // Restoring the source for the next handler to use.
       event.overrideSource(oldSource);
     }
   }
 }
}

int getAbsoluteLeft() #

inherited from UiObject

Gets the object's absolute left position in pixels, as measured from the browser window's client area.

@return the object's absolute left position

int getAbsoluteLeft() {
 return Dom.getAbsoluteLeft(getElement());
}

int getAbsoluteTop() #

inherited from UiObject

Gets the object's absolute top position in pixels, as measured from the browser window's client area.

@return the object's absolute top position

int getAbsoluteTop() {
 return Dom.getAbsoluteTop(getElement());
}

AutoHorizontalAlignmentConstant getAutoHorizontalAlignment() #

inherited from LabelBase

Gets the horizontal auto-alignment setting. This may be one of the auto-alignment values above that depend on content direction (e.g. {@link HasAutoHorizontalAlignment#ALIGNCONTENTSTART}), or one of the "static" {@link HasHorizontalAlignment.HorizontalAlignmentConstant} alignment values (e.g. {@link HasHorizontalAlignment#ALIGNLOCALESTART}). It may be set by either {@code setAutoHorizontalAlignment} or {@code 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.

@return the current automatic horizontal alignment policy.

docs inherited from HasAutoHorizontalAlignment
AutoHorizontalAlignmentConstant getAutoHorizontalAlignment() {
 return _autoHorizontalAlignment;
}

DirectionEstimator getDirectionEstimator() #

inherited from LabelBase

Returns the {@code DirectionEstimator} object.

DirectionEstimator getDirectionEstimator() {
 return directionalTextHelper.getDirectionEstimator();
}

Element getElement() #

inherited from UiObject

Gets this object's browser element.

dart_html.Element getElement() {
 assert (_element != null); // : MISSING_ELEMENT_ERROR;
 return _element;
}

EventBus getEventBus() #

inherited from Widget

Return EventBus.

EventBus getEventBus() {
 return _eventBus;
}

HorizontalAlignmentConstant getHorizontalAlignment() #

inherited from LabelBase

Gets the horizontal alignment.

@return the current horizontal alignment (

    {@link HasHorizontalAlignment#ALIGN_LEFT},
    {@link HasHorizontalAlignment#ALIGN_CENTER},
    {@link HasHorizontalAlignment#ALIGN_RIGHT},
    {@link HasHorizontalAlignment#ALIGN_JUSTIFY}, or
    null).
docs inherited from HasHorizontalAlignment
HorizontalAlignmentConstant getHorizontalAlignment() {
 return _horzAlign;
}

Object getLayoutData() #

inherited from Widget

Gets the panel-defined layout data associated with this widget.

@return the widget's layout data @see #setLayoutData

Object getLayoutData() {
 return _layoutData;
}

int getOffsetHeight() #

inherited from UiObject

Gets the object's offset height in pixels. This is the total height of the object, including decorations such as border and padding, but not margin.

@return the object's offset height

int getOffsetHeight() {
 return getElement().offset.height; // Dom.getElementPropertyInt(getElement(), "offsetHeight");
}

int getOffsetWidth() #

inherited from UiObject

Gets the object's offset width in pixels. This is the total width of the object, including decorations such as border and padding, but not margin.

@return the object's offset width

int getOffsetWidth() {
 return getElement().offset.width; // Dom.getElementPropertyInt(getElement(), "offsetWidth");
}

Widget getParent() #

inherited from Widget

Gets this widget's parent panel.

@return the widget's parent panel

Widget getParent() {
 return _parent;
}

Element getStyleElement() #

inherited from UiObject

Template method that returns the element to which style names will be applied. By default it returns the root element, but this method may be overridden to apply styles to a child element.

@return the element to which style names will be applied

dart_html.Element getStyleElement() {
 return getElement();
}

String getStyleName() #

inherited from UiObject

Gets all of the object's style names, as a space-separated list. If you wish to retrieve only the primary style name, call {@link #getStylePrimaryName()}.

@return the objects's space-separated style names @see #getStylePrimaryName()

String getStyleName() {
 return getElementStyleName(getStyleElement());
}

String getStylePrimaryName() #

inherited from UiObject

Gets the primary style name associated with the object.

@return the object's primary style name @see #setStyleName(String) @see #addStyleName(String) @see #removeStyleName(String)

String getStylePrimaryName() {
 return getElementStylePrimaryName(getStyleElement());
}

Direction getTextDirection() #

inherited from Label

Gets the direction of this object's text.

@return the direction of this object's text

docs inherited from HasDirectionalText
Direction getTextDirection() {
 return directionalTextHelper.getTextDirection();
}

String getTextOrHtml(bool isHtml) #

inherited from Html
String getTextOrHtml(bool isHtml) {
 return directionalTextHelper.getTextOrHtml(isHtml);
}

bool isAttached() #

inherited from Widget

Returns whether or not the receiver is attached to the {@link com.google.gwt.dom.client.Document Document}'s {@link com.google.gwt.dom.client.BodyElement BodyElement}.

@return true if attached, false otherwise

bool isAttached() {
 return _attached;
}

bool isOrWasAttached() #

inherited from Widget

Has this widget ever been attached?

@return true if this widget ever been attached to the DOM, false otherwise

bool isOrWasAttached() {
 return eventsToSink == -1;
}

void onAttach() #

inherited from Widget

This method is called when a widget is attached to the browser's document. To receive notification after a Widget has been added to the document, override the {@link #onLoad} method or use {@link #addAttachHandler}.

It is strongly recommended that you override {@link #onLoad()} or {@link #doAttachChildren()} instead of this method to avoid inconsistencies between logical and physical attachment states.

Subclasses that override this method must call super.onAttach() to ensure that the Widget has been attached to its underlying Element.

@throws IllegalStateException if this widget is already attached @see #onLoad() @see #doAttachChildren()

void onAttach() {
 if (isAttached()) {
   throw new Exception("Should only call onAttach when the widget is detached from the browser's document");
 }

 _attached = true;

 // Event hookup code
 Dom.setEventListener(getElement(), this);
 int bitsToAdd = eventsToSink;
 eventsToSink = -1;
 if (bitsToAdd > 0) {
   sinkEvents(bitsToAdd);
 }
 doAttachChildren();

 // onLoad() gets called only *after* all of the children are attached and
 // the attached flag is set. This allows widgets to be notified when they
 // are fully attached, and panels when all of their children are attached.
 onLoad();
 AttachEvent.fire(this, true);
}

void onBrowserEvent(Event event) #

inherited from Widget

Fired whenever a browser event is received.

@param event the event received

TODO

void onBrowserEvent(dart_html.Event event) {
 switch (Dom.eventGetType(event)) {
   case IEvent.ONMOUSEOVER:
     // Only fire the mouse over event if it's coming from outside this
     // widget.
   case IEvent.ONMOUSEOUT:
     // Only fire the mouse over event if it's coming from outside this widget.
     // Only fire the mouse out event if it's leaving this widget.
     dart_html.Element related = (event as dart_html.MouseEvent).relatedTarget as dart_html.Element;
     if (related != null && Dom.isOrHasChild(getElement(), related)) {
       return;
     }
     break;
 }

 DomEvent.fireNativeEvent(event, this, this.getElement());
}

void onDetach() #

inherited from Widget

This method is called when a widget is detached from the browser's document. To receive notification before a Widget is removed from the document, override the {@link #onUnload} method or use {@link #addAttachHandler}.

It is strongly recommended that you override {@link #onUnload()} or {@link #doDetachChildren()} instead of this method to avoid inconsistencies between logical and physical attachment states.

Subclasses that override this method must call super.onDetach() to ensure that the Widget has been detached from the underlying Element. Failure to do so will result in application memory leaks due to circular references between DOM Elements and JavaScript objects.

@throws IllegalStateException if this widget is already detached @see #onUnload() @see #doDetachChildren()

void onDetach() {
 if (!isAttached()) {
   throw new Exception("Should only call onDetach when the widget is attached to the browser's document");
 }

 try {
   // onUnload() gets called *before* everything else (the opposite of
   // onLoad()).
   onUnload();
   AttachEvent.fire(this, false);
 } finally {
   // Put this in a finally, just in case onUnload throws an exception.
   try {
     doDetachChildren();
   } finally {
     // Put this in a finally, in case doDetachChildren throws an exception.
     Dom.setEventListener(getElement(), null);
     _attached = false;
   }
 }
}

void onLoad() #

inherited from Widget

This method is called immediately after a widget becomes attached to the browser's document.

void onLoad() {
}

void onUnload() #

inherited from Widget

This method is called immediately before a widget will be detached from the browser's document.

void onUnload() {
}

void removeFromParent() #

inherited from Widget

Removes this widget from its parent widget, if one exists.

If it has no parent, this method does nothing. If it is a "root" widget (meaning it's been added to the detach list via {@link RootPanel#detachOnWindowClose(Widget)}), it will be removed from the detached immediately. This makes it possible for Composites and Panels to adopt root widgets.

@throws IllegalStateException if this widget's parent does not support

      removal (e.g. {@link Composite})
void removeFromParent() {
 if (_parent == null) {
   // If the widget had no parent, check to see if it was in the detach list
   // and remove it if necessary.
   if (RootPanel.isInDetachList(this)) {
     RootPanel.detachNow(this);
   }
 } else if (_parent is HasWidgets) {
   (_parent as HasWidgets).remove(this);
 } else if (_parent != null) {
   throw new Exception("This widget's parent does not implement HasWidgets");
 }
}

void removeStyleDependentName(String styleSuffix) #

inherited from UiObject

Removes a dependent style name by specifying the style name's suffix.

@param styleSuffix the suffix of the dependent style to be removed @see #setStylePrimaryName(Element, String) @see #addStyleDependentName(String) @see #setStyleDependentName(String, boolean)

void removeStyleDependentName(String styleSuffix) {
 setStyleDependentName(styleSuffix, false);
}

void removeStyleName(String style) #

inherited from UiObject

Removes a style name. This method is typically used to remove secondary style names, but it can be used to remove primary stylenames as well. That use is not recommended.

@param style the secondary style name to be removed @see #addStyleName(String) @see #setStyleName(String, boolean)

void removeStyleName(String style) {
 setStyleName(style, false);
}

void replaceElement(Element elem) #

inherited from Widget

Replaces this object's browser element.

This method exists only to support a specific use-case in Image, and should not be used by other classes.

@param elem the object's new element

void replaceElement(dart_html.Element elem) {
 if (isAttached()) {
   // Remove old event listener to avoid leaking. onDetach will not do this
   // for us, because it is only called when the widget itself is detached
   // from the document.
   Dom.setEventListener(getElement(), null);
 }

 super.replaceElement(elem);

 if (isAttached()) {
   // Hook the event listener back up on the new element. onAttach will not
   // do this for us, because it is only called when the widget itself is
   // attached to the document.
   Dom.setEventListener(getElement(), this);
 }
}

void setAutoHorizontalAlignment(AutoHorizontalAlignmentConstant autoAlignment) #

inherited from LabelBase

Sets the horizontal alignment, allowing in addition to the "static" {@link HasHorizontalAlignment.HorizontalAlignmentConstant} values, the "automatic" {@link HasHorizontalAlignment.AutoHorizontalAlignmentConstant} values that depend on the content direction. Determines the values returned by both {@link #getAutoHorizontalAlignment} and {@link HasHorizontalAlignment#getHorizontalAlignment()}. <p> For the {@code ALIGNCONTENTSTART} and {@code ALIGNCONTENTEND} values, sets the horizontal alignment (including the value of {@code 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. <p> For other values, operates like {@link #setHorizontalAlignment}. <p> For {@code null}, the horizontal alignment is cleared, allowing it to be determined by the standard HTML mechanisms such as inheritance and CSS rules. @see HasHorizontalAlignment

@param autoHorizontalAlignment the new automatic horizontal alignment

   policy
docs inherited from HasAutoHorizontalAlignment
void setAutoHorizontalAlignment(AutoHorizontalAlignmentConstant autoAlignment) {
 _autoHorizontalAlignment = autoAlignment;
 updateHorizontalAlignment();
}

void setDirectionEstimator(DirectionEstimator directionEstimator) #

inherited from LabelBase

{@inheritDoc} <p> 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.

void setDirectionEstimator(DirectionEstimator directionEstimator) {
 directionalTextHelper.setDirectionEstimator(directionEstimator);
 updateHorizontalAlignment();
}

void setElement(Element elem) #

inherited from UiObject

Sets this object's browser element. UIObject subclasses must call this method before attempting to call any other methods, and it may only be called once.

@param elem the object's element

void setElement(dart_html.Element elem) {
 assert (_element == null);
 this._element = elem;
}

void setHeight(String height) #

inherited from UiObject

Sets the object's height. This height does not include decorations such as border, margin, and padding.

@param height the object's new height, in CSS units (e.g. "10px", "1em")

void setHeight(String height) {
 // This exists to deal with an inconsistency in IE's implementation where
 // it won't accept negative numbers in length measurements
 assert (extractLengthValue(height.trim().toLowerCase()) >= 0); // : "CSS heights should not be negative";
 Dom.setStyleAttribute(getElement(), "height", height);
}

void setHorizontalAlignment(HorizontalAlignmentConstant align) #

inherited from LabelBase

{@inheritDoc}

Note: A subsequent call to {@link #setAutoHorizontalAlignment} may override the horizontal alignment set by this method.

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

@see #setAutoHorizontalAlignment

void setHorizontalAlignment(HorizontalAlignmentConstant align) {
 setAutoHorizontalAlignment(align);
}

void setHtml(String val, Direction dir) #

inherited from Html

Sets the label's content to the given HTML, applying the given direction. See {@link #setText(String, com.google.gwt.i18n.client.HasDirection.Direction) setText(String, Direction)} for details on potential effects on alignment.

@param html the new widget's HTML content @param dir the content's direction. Note: {@code Direction.DEFAULT} means

     direction should be inherited from the widget's parent element.
void setHtml(String val, Direction dir) {
 directionalTextHelper.setTextOrHtml(val, true, dir);
 updateHorizontalAlignment();
}

void setLayoutData(Object value) #

inherited from Widget

Sets the panel-defined layout data associated with this widget. Only the panel that currently contains a widget should ever set this value. It serves as a place to store layout bookkeeping data associated with a widget.

@param layoutData the widget's layout data

void setLayoutData(Object value) {
 this._layoutData = value;
}

void setParent(Widget parent) #

inherited from Widget

Sets this widget's parent. This method should only be called by {@link Panel} and {@link Composite}.

@param parent the widget's new parent @throws IllegalStateException if <code>parent</code> is non-null and the

      widget already has a parent
void setParent(Widget parent) {
 Widget oldParent = this._parent;
 if (parent == null) {
   try {
     if (oldParent != null && oldParent.isAttached()) {
       onDetach();
       assert (!isAttached()); // : "Failure of " + this.getClass().getName() + " to call super.onDetach()";
     }
   } finally {
     // Put this in a finally in case onDetach throws an exception.
     this._parent = null;
   }
 } else {
   if (oldParent != null) {
     throw new Exception("Cannot set a new parent without first clearing the old parent");
   }
   this._parent = parent;
   if (parent.isAttached()) {
     onAttach();
     assert (isAttached()); // : "Failure of " + this.getClass().getName() + " to call super.onAttach()";
   }
 }
}

void setPixelSize(int width, int height) #

inherited from UiObject

Sets the object's size, in pixels, not including decorations such as border, margin, and padding.

@param width the object's new width, in pixels @param height the object's new height, in pixels

void setPixelSize(int width, int height) {
 if (width >= 0) {
   setWidth(width.toString() + "px");
 }
 if (height >= 0) {
   setHeight(height.toString() + "px");
 }
}

void setSize(String width, String height) #

inherited from UiObject

Sets the object's size. This size does not include decorations such as border, margin, and padding.

@param width the object's new width, in CSS units (e.g. "10px", "1em") @param height the object's new height, in CSS units (e.g. "10px", "1em")

void setSize(String width, String height) {
 setWidth(width);
 setHeight(height);
}

void setStyleDependentName(String styleSuffix, bool add) #

inherited from UiObject

Adds or removes a dependent style name by specifying the style name's suffix. The actual form of the style name that is added is:

getStylePrimaryName() + '-' + styleSuffix

@param styleSuffix the suffix of the dependent style to be added or removed @param add <code>true</code> to add the given style, <code>false</code> to

     remove it

@see #setStylePrimaryName(Element, String) @see #addStyleDependentName(String) @see #setStyleName(String, boolean) @see #removeStyleDependentName(String)

void setStyleDependentName(String styleSuffix, bool add) {
 setStyleName(getStylePrimaryName() + '-' + styleSuffix, add);
}

void setStyleName(String style, bool add) #

inherited from UiObject

Adds or removes a style name. This method is typically used to remove secondary style names, but it can be used to remove primary stylenames as well. That use is not recommended.

@param style the style name to be added or removed @param add <code>true</code> to add the given style, <code>false</code> to

     remove it

@see #addStyleName(String) @see #removeStyleName(String)

void setStyleName(String style, bool add) {
 manageElementStyleName(getStyleElement(), style, add);
}

void setStylePrimaryName(String style) #

inherited from UiObject

Sets the object's primary style name and updates all dependent style names.

@param style the new primary style name @see #addStyleName(String) @see #removeStyleName(String)

void setStylePrimaryName(String style) {
 setElementStylePrimaryName(getStyleElement(), style);
}

void setText(String text, Direction dir) #

inherited from Label

Sets the label's content to the given text, applying the given direction. <p> This will have the following effect on the horizontal alignment: <ul> <li> If the automatic alignment setting is ALIGNCONTENTSTART or ALIGNCONTENTEND, the horizontal alignment will be set to match the start or end edge, respectively, of the new direction (the {@code dir} parameter). If that is DEFAULT, the locale direction is used. <li> Otherwise, the horizontal alignment value is not changed, but the effective alignment may nevertheless change according to the usual HTML rules, i.e. it will match the start edge of the new direction if the widget element is a <div> and has no explicit alignment value even by inheritance. </ul>

@param text the widget's new text @param dir the text's direction. Note: {@code Direction.DEFAULT} means

   direction should be inherited from the widget's parent element.
void setText(String text, Direction dir) {
 directionalTextHelper.setTextOrHtml(text, false, dir);
 updateHorizontalAlignment();
}

void setWidth(String width) #

inherited from UiObject

Sets the object's width. This width does not include decorations such as border, margin, and padding.

@param width the object's new width, in CSS units (e.g. "10px", "1em")

void setWidth(String width) {
 // This exists to deal with an inconsistency in IE's implementation where
 // it won't accept negative numbers in length measurements
 assert (extractLengthValue(width.trim().toLowerCase()) >= 0); // : "CSS widths should not be negative";
 Dom.setStyleAttribute(getElement(), "width", width);
}

void sinkBitlessEvent(String eventTypeName) #

inherited from UiObject

Sinks a named event. Note that only {@link Widget widgets} may actually receive events, but can receive events from all objects contained within them.

@param eventTypeName name of the event to sink on this element @see com.google.gwt.user.client.Event

void sinkBitlessEvent(String eventTypeName) {
 Dom.sinkBitlessEvent(getElement(), eventTypeName);
}

void sinkEvents(int eventBitsToAdd) #

inherited from Widget

Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement. Subclasses wishing to customize sinkEvents can preserve this deferred sink behavior by putting their implementation behind a check of <code>isOrWasAttached()</code>:

{@literal @}Override
public void sinkEvents(int eventBitsToAdd) {
  if (isOrWasAttached()) {
    /{@literal *} customized sink code goes here {@literal *}/
  } else {
    super.sinkEvents(eventBitsToAdd);
 }
} 
void sinkEvents(int eventBitsToAdd) {
 if (isOrWasAttached()) {
   super.sinkEvents(eventsToSink);
 } else {
   eventsToSink |= eventBitsToAdd;
 }
}

String toString() #

inherited from UiObject

This method is overridden so that any object can be viewed in the debugger as an HTML snippet.

@return a string representation of the object

String toString() {
 if (_element == null) {
   return "(null handle)";
 }
 return getElement().toString();
}

void unsinkEvents(int eventBitsToRemove) #

inherited from UiObject

Removes a set of events from this object's event list.

@param eventBitsToRemove a bitfield representing the set of events to be

     removed from this element's event set

@see #sinkEvents @see com.google.gwt.user.client.Event

void unsinkEvents(int eventBitsToRemove) {
 Dom.sinkEvents(getElement(), Dom.getEventsSunk(getElement()) & (~eventBitsToRemove));
}

void updateHorizontalAlignment() #

inherited from LabelBase

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.

void updateHorizontalAlignment() {
 HorizontalAlignmentConstant align;
 if (_autoHorizontalAlignment == null) {
   align = null;
 } else if (_autoHorizontalAlignment is HorizontalAlignmentConstant) {
   align = _autoHorizontalAlignment as HorizontalAlignmentConstant;
 } else {
   /*
    * autoHorizontalAlignment is a truly automatic policy, i.e. either
    * ALIGN_CONTENT_START or ALIGN_CONTENT_END
    */
   align = _autoHorizontalAlignment == HasAutoHorizontalAlignment.ALIGN_CONTENT_START
       ? HorizontalAlignmentConstant.startOf(directionalTextHelper.getTextDirection())
       : HorizontalAlignmentConstant.endOf(directionalTextHelper.getTextDirection());
 }

 if (align != _horzAlign) {
   _horzAlign = align;
   getElement().style.textAlign = _horzAlign == null ? "" : _horzAlign.getTextAlignString();
 }
}