com.vaadin.terminal.gwt.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.terminal.gwt.client.VCaption

All Implemented Interfaces:

com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.LeafValueEditor<String>>, 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.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.HasWordWrap, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesMouseEvents

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

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
protected static String ATTRIBUTE_CAPTION
           
protected static String ATTRIBUTE_DESCRIPTION
           
protected static String ATTRIBUTE_ERROR
           
protected static String ATTRIBUTE_HIDEERRORS
           
protected static String ATTRIBUTE_ICON
           
protected static String ATTRIBUTE_REQUIRED
           
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
VCaption(Paintable component, ApplicationConnection client)
           
 
Method Summary
static String getCaptionOwnerPid(com.google.gwt.user.client.Element e)
           
 int getHeight()
           
 Paintable getOwner()
          Returns Paintable for which this Caption belongs to.
static String getOwnerPid(com.google.gwt.user.client.Element el)
           
 int getRenderedWidth()
           
 int getRequiredWidth()
           
protected  com.google.gwt.user.client.Element getTextElement()
           
static boolean isNeeded(UIDL uidl)
           
 void onBrowserEvent(com.google.gwt.user.client.Event event)
           
 void setAlignment(String alignment)
           
 void setMaxWidth(int maxWidth)
           
 boolean shouldBePlacedAfterComponent()
           
 boolean updateCaption(UIDL uidl)
          Updates the caption from UIDL.
 
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, 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, onAttach, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
 
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, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents
 
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.user.client.ui.HasText
getText, setText
 
Methods inherited from interface com.google.gwt.user.client.ui.HasText
getText, setText
 
Methods inherited from interface com.google.gwt.user.client.ui.HasDirectionalText
getTextDirection, setText
 
Methods inherited from interface com.google.gwt.user.client.ui.HasText
getText, setText
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Field Detail

CLASSNAME

public static final String CLASSNAME

See Also:

Constant Field Values

ATTRIBUTE_ICON

protected static final String ATTRIBUTE_ICON

See Also:

Constant Field Values

ATTRIBUTE_CAPTION

protected static final String ATTRIBUTE_CAPTION

See Also:

Constant Field Values

ATTRIBUTE_DESCRIPTION

protected static final String ATTRIBUTE_DESCRIPTION

See Also:

Constant Field Values

ATTRIBUTE_REQUIRED

protected static final String ATTRIBUTE_REQUIRED

See Also:

Constant Field Values

ATTRIBUTE_ERROR

protected static final String ATTRIBUTE_ERROR

See Also:

Constant Field Values

ATTRIBUTE_HIDEERRORS

protected static final String ATTRIBUTE_HIDEERRORS

See Also:

Constant Field Values

Constructor Detail

VCaption

public VCaption(Paintable component,
                ApplicationConnection client)

Parameters:

component - optional owner of caption. If not set, getOwner will return null

client -

Method Detail

updateCaption

public boolean updateCaption(UIDL uidl)

Updates the caption from UIDL.

Parameters:
uidl -
Returns:
true if the position where the caption should be placed has changed

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(UIDL uidl)

getOwner

public Paintable 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)

getTextElement

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

getCaptionOwnerPid

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

getOwnerPid

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