org.gwtbootstrap3.client.ui

Class HelpBlock

Object

UIObject

Widget

AbstractTextWidget

HelpBlock

All Implemented Interfaces:

IsEditor<LeafValueEditor<String>>, HasAttachHandlers, HasHandlers, EventListener, HasHTML, HasText, HasVisibility, IsWidget, HasId, HasInlineStyle, HasPull, HasResponsiveness

Direct Known Subclasses:

InlineHelpBlock

public class HelpBlock
extends AbstractTextWidget

Help block. Call setError(String) to set ther error state of this HelpBlock.

Author:

Joshua Godi, Steven Jardine

Nested Class Summary

Nested classes/interfaces inherited from class UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
HelpBlock() Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearError() Clear the error state of this help block.
protected Element	createIconElement()
IconType	getIconType()
boolean	isError() Checks if this block is in the error state.
void	setError(String message) Set this HelpBlock's error state.
void	setHTML(String value)
void	setIconType(IconType type) Sets the icon type.
void	setText(String value)

Methods inherited from class AbstractTextWidget

asEditor, getHTML, getId, getPull, getText, setColor, setHiddenOn, setId, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPull, setVisibleOn

Methods inherited from class Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class Object

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

Constructor Detail

HelpBlock

public HelpBlock()

Constructor.

Method Detail

clearError

public void clearError()

Clear the error state of this help block.

createIconElement

protected Element createIconElement()

Returns:

a new icon element. We only create this when iconElement is null or the iconType has changed.

getIconType

public IconType getIconType()

Returns:

the icon type

isError

public boolean isError()

Checks if this block is in the error state.

Returns:

true, if is error

setError

public void setError(String message)

Set this HelpBlock's error state.

Parameters:

message - the error message.

setHTML

public void setHTML(String value)

Specified by:

setHTML in interface HasHTML

Overrides:

setHTML in class AbstractTextWidget

setIconType

public void setIconType(IconType type)

Sets the icon type. If the icon type changes programatically then the icon is removed from the dom and recreated.

Parameters:

type - the new icon type

setText

public void setText(String value)

Specified by:

setText in interface HasText

Overrides:

setText in class AbstractTextWidget