Package com.vaadin.client

Class VCaption

java.lang.Object

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

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

com.google.gwt.user.client.ui.LabelBase<String>

com.google.gwt.user.client.ui.Label

com.google.gwt.user.client.ui.HTML

com.vaadin.client.VCaption

All Implemented Interfaces:

com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.LeafValueEditor<String>>, com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.i18n.client.HasDirection, com.google.gwt.i18n.shared.HasDirectionEstimator, com.google.gwt.safehtml.client.HasSafeHtml, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasAutoHorizontalAlignment, com.google.gwt.user.client.ui.HasDirectionalHtml, com.google.gwt.user.client.ui.HasDirectionalSafeHtml, com.google.gwt.user.client.ui.HasDirectionalText, com.google.gwt.user.client.ui.HasHorizontalAlignment, com.google.gwt.user.client.ui.HasHTML, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWordWrap, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesMouseEvents, HasErrorIndicatorElement

Direct Known Subclasses:

VTabsheet.TabCaption

public class VCaption
extends com.google.gwt.user.client.ui.HTML
implements HasErrorIndicatorElement

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.i18n.client.HasDirection

com.google.gwt.i18n.client.HasDirection.Direction

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

com.google.gwt.user.client.ui.HasHorizontalAlignment.AutoHorizontalAlignmentConstant, com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLASSNAME

Fields inherited from class com.google.gwt.user.client.ui.Label

DEFAULT_DIRECTION_ESTIMATOR

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Fields inherited from interface com.google.gwt.user.client.ui.HasAutoHorizontalAlignment

ALIGN_CONTENT_END, ALIGN_CONTENT_START

Fields inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT

Constructor Summary

Constructors

Constructor	Description
VCaption(ApplicationConnection client)	Deprecated. all captions should be associated with a paintable widget and be updated from shared state, not UIDL
VCaption(ComponentConnector component, ApplicationConnection client)	Creates a caption for a ComponentConnector.

Method Summary

Modifier and Type	Method	Description
static String	getCaptionOwnerPid(com.google.gwt.dom.client.Element e)
com.google.gwt.dom.client.Element	getErrorIndicatorElement()	Gets the error indicator element.
int	getHeight()
ComponentConnector	getOwner()	Returns Paintable for which this Caption belongs to.
static String	getOwnerPid(com.google.gwt.dom.client.Element el)
int	getRenderedWidth()
int	getRequiredWidth()
protected com.google.gwt.user.client.Element	getTextElement()
TooltipInfo	getTooltipInfo()	Returns the tooltip that should be shown for the caption.
boolean	isCaptionAsHtml()	Checks whether captions are rendered as HTML.
static boolean	isNeeded(ComponentConnector connector)
static boolean	mightChange(StateChangeEvent event)	Checks whether anything in a given state change might cause the caption to change.
protected void	onAttach()
void	onBrowserEvent(com.google.gwt.user.client.Event event)
protected void	onDetach()
void	setAlignment(String alignment)
void	setCaptionAsHtml(boolean captionAsHtml)	Sets whether the caption is rendered as HTML.
static void	setCaptionText(com.google.gwt.dom.client.Element captionElement, AbstractComponentState state)	Sets the text of the given caption element to the caption found in the state.
static void	setCaptionText(com.google.gwt.user.client.ui.HasHTML widget, AbstractComponentState state)	Sets the text of the given widget to the caption found in the state.
void	setErrorIndicatorElementVisible(boolean visible)	Sets the visibility of the error indicator element.
void	setMaxWidth(int maxWidth)
void	setTooltipInfo(TooltipInfo tooltipInfo)	Sets the tooltip that should be shown for the caption.
boolean	shouldBePlacedAfterComponent()
boolean	updateCaption()	Updates the caption from UIDL.
boolean	updateCaptionWithoutOwner(String caption, boolean disabled, boolean hasDescription, boolean hasError, ErrorLevel errorLevel, String iconURL, String iconAltText)	Deprecated.
boolean	updateCaptionWithoutOwner(String caption, boolean disabled, boolean hasDescription, boolean hasError, String iconURL)	Deprecated.
boolean	updateCaptionWithoutOwner(String caption, boolean disabled, boolean hasDescription, boolean hasError, String iconURL, String iconAltText)	Deprecated.

Methods inherited from class com.google.gwt.user.client.ui.HTML

getHTML, getTextOrHtml, setHTML, setHTML, setHTML, setHTML, wrap

Methods inherited from class com.google.gwt.user.client.ui.Label

addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, asEditor, getDirection, getText, getTextDirection, removeClickListener, removeMouseListener, removeMouseWheelListener, setDirection, setText, setText

Methods inherited from class com.google.gwt.user.client.ui.LabelBase

getAutoHorizontalAlignment, getDirectionEstimator, getHorizontalAlignment, getWordWrap, setAutoHorizontalAlignment, setDirectionEstimator, setDirectionEstimator, setHorizontalAlignment, setWordWrap, updateHorizontalAlignment

Methods inherited from class com.google.gwt.user.client.ui.Widget

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

Methods inherited from class com.google.gwt.user.client.ui.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 java.lang.Object

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

Methods inherited from interface com.google.gwt.user.client.ui.HasDirectionalText

getTextDirection, setText

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface com.google.gwt.user.client.ui.HasText

getText, setText

Field Detail

CLASSNAME

public static final String CLASSNAME

See Also:

Constant Field Values

Constructor Detail

VCaption

@Deprecated
public VCaption(ApplicationConnection client)

Deprecated.

all captions should be associated with a paintable widget and be updated from shared state, not UIDL

Creates a caption that is not linked to a ComponentConnector. When using this constructor, getOwner() returns null.

Parameters:

client - ApplicationConnection

VCaption

public VCaption(ComponentConnector component,
                ApplicationConnection client)

Creates a caption for a ComponentConnector.

Parameters:

component - owner of caption, not null

client - ApplicationConnection

Method Detail

onAttach

protected void onAttach()

Overrides:

onAttach in class com.google.gwt.user.client.ui.Widget

onDetach

protected void onDetach()

Overrides:

onDetach in class com.google.gwt.user.client.ui.Widget

updateCaption

public boolean updateCaption()

Updates the caption from UIDL. This method may only be called when the caption has an owner - otherwise, use #updateCaptionWithoutOwner(UIDL, String, boolean, boolean).

Returns:

true if the position where the caption should be placed has changed

updateCaptionWithoutOwner

@Deprecated
public boolean updateCaptionWithoutOwner(String caption,
                                         boolean disabled,
                                         boolean hasDescription,
                                         boolean hasError,
                                         String iconURL)

Deprecated.

updateCaptionWithoutOwner

@Deprecated
public boolean updateCaptionWithoutOwner(String caption,
                                         boolean disabled,
                                         boolean hasDescription,
                                         boolean hasError,
                                         String iconURL,
                                         String iconAltText)

Deprecated.

updateCaptionWithoutOwner

@Deprecated
public boolean updateCaptionWithoutOwner(String caption,
                                         boolean disabled,
                                         boolean hasDescription,
                                         boolean hasError,
                                         ErrorLevel errorLevel,
                                         String iconURL,
                                         String iconAltText)

Deprecated.

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.Widget

isNeeded

public static boolean isNeeded(ComponentConnector connector)

mightChange

public static boolean mightChange(StateChangeEvent event)

Checks whether anything in a given state change might cause the caption to change.

Parameters:

event - the state change event to check

Returns:

true if the caption might have changed; otherwise false

getOwner

public ComponentConnector getOwner()

Returns Paintable for which this Caption belongs to.

Returns:

owner Widget

shouldBePlacedAfterComponent

public boolean shouldBePlacedAfterComponent()

getRenderedWidth

public int getRenderedWidth()

getRequiredWidth

public int getRequiredWidth()

getHeight

public int getHeight()

setAlignment

public void setAlignment(String alignment)

setMaxWidth

public void setMaxWidth(int maxWidth)

setTooltipInfo

public void setTooltipInfo(TooltipInfo tooltipInfo)

Sets the tooltip that should be shown for the caption.

Parameters:

tooltipInfo - The tooltip that should be shown or null if no tooltip should be shown

getTooltipInfo

public TooltipInfo getTooltipInfo()

Returns the tooltip that should be shown for the caption.

Returns:

The tooltip to show or null if no tooltip should be shown

getTextElement

protected com.google.gwt.user.client.Element getTextElement()

getCaptionOwnerPid

public static String getCaptionOwnerPid(com.google.gwt.dom.client.Element e)

getOwnerPid

public static String getOwnerPid(com.google.gwt.dom.client.Element el)

setCaptionAsHtml

public void setCaptionAsHtml(boolean captionAsHtml)

Sets whether the caption is rendered as HTML.

Default is false

Parameters:

captionAsHtml - true if the captions are rendered as HTML, false if rendered as plain text

isCaptionAsHtml

public boolean isCaptionAsHtml()

Checks whether captions are rendered as HTML.

Default is false

Returns:

true if the captions are rendered as HTML, false if rendered as plain text

setCaptionText

public static void setCaptionText(com.google.gwt.dom.client.Element captionElement,
                                  AbstractComponentState state)

Sets the text of the given caption element to the caption found in the state.

Uses AbstractComponentState.captionAsHtml to determine whether to set the caption as html or plain text

Parameters:

captionElement - the target element

state - the state from which to read the caption text and mode

Since:

7.4

setCaptionText

public static void setCaptionText(com.google.gwt.user.client.ui.HasHTML widget,
                                  AbstractComponentState state)

Sets the text of the given widget to the caption found in the state.

Uses AbstractComponentState.captionAsHtml to determine whether to set the caption as html or plain text

Parameters:

widget - the target widget

state - the state from which to read the caption text and mode

Since:

7.4

getErrorIndicatorElement

public com.google.gwt.dom.client.Element getErrorIndicatorElement()

Description copied from interface: HasErrorIndicatorElement

Gets the error indicator element.

Specified by:

getErrorIndicatorElement in interface HasErrorIndicatorElement

Returns:

the error indicator element

setErrorIndicatorElementVisible

public void setErrorIndicatorElementVisible(boolean visible)

Description copied from interface: HasErrorIndicatorElement

Sets the visibility of the error indicator element.

Specified by:

setErrorIndicatorElementVisible in interface HasErrorIndicatorElement

Parameters:

visible - true to show the error indicator element, false to hide it