Component (GXT 4.0.2)

java.lang.Object
- Widget
- - com.sencha.gxt.widget.core.client.Component

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

Direct Known Subclasses:

CellComponent, CollapsePanel, ColumnFooter, ColumnHeader, ColumnHeader.GridSplitBar, ColumnHeader.Group, ColumnHeader.Head, Composite, Container, DatePicker, DrawComponent, FileUploadField, FillToolItem, Grid, GridRowEditing.RowEditorComponent, Header, IconButton, Info, Insert, Item, LabelToolItem, ListView, MenuBarItem, ModalPanel, SeparatorToolItem, SplitBar, Status, StatusProxy, TabPanel, Tip, Tree
```
public class Component
extends Widget
implements FocusEvent.HasFocusHandlers, BlurEvent.HasBlurHandlers, BeforeHideEvent.HasBeforeHideHandlers, HideEvent.HasHideHandlers, BeforeShowEvent.HasBeforeShowHandlers, ShowEvent.HasShowHandlers, EnableEvent.HasEnableHandlers, DisableEvent.HasDisableHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, ShowContextMenuEvent.HasShowContextMenuHandler, MoveEvent.HasMoveHandlers, HasItemId, HasFocusSupport, HasGestureRecognizers
```
Base class for all GXT widgets.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`adjustSize` True to adjust sizes for box model issues to ensure actual size matches set size.
`protected boolean`	`allowTextSelection`
`protected boolean`	`cacheSizes` True to cache size calculation (defaults to true) for better performance.
`protected boolean`	`disableContextMenu`
`protected boolean`	`disabled` True if the widget is disabled.
`protected String`	`disabledStyle` The style used when a widget is disabled (defaults to `ThemeStyles.getStyle().disabled()`).
`protected boolean`	`ensureVisibilityOnSizing` Set this to true if you have sizing issues in initial collapsed or hidden items.
`protected String`	`height`
`protected boolean`	`hidden` True if this widget is hidden.
`protected Size`	`lastSize` The size of the widget that last time it was changed.
`protected Layer`	`layer`
`protected int`	`left`
`protected boolean`	`mask`
`protected String`	`maskMessage`
`protected boolean`	`monitorWindowResize`
`protected int`	`pageX`
`protected int`	`pageY`
`protected HandlerRegistration`	`resizeHandler`
`protected boolean`	`shim` True to enable a shim which uses a transparent iframe to stop content from bleeding through.
`protected int`	`tabIndex`
`protected ToolTip`	`toolTip`
`protected ToolTipConfig`	`toolTipConfig`
`protected int`	`top`
`protected String`	`width`
`protected int`	`windowResizeDelay`
`protected DelayedTask`	`windowResizeTask`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Component()

Constructors
Modifier	Constructor and Description
`protected`	`Component()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addBeforeHideHandler(BeforeHideEvent.BeforeHideHandler handler)` Adds a `BeforeHideEvent.BeforeHideHandler` handler for `BeforeHideEvent` events.
`HandlerRegistration`	`addBeforeShowContextMenuHandler(BeforeShowContextMenuEvent.BeforeShowContextMenuHandler handler)` Adds a `BeforeShowContextMenuEvent.BeforeShowContextMenuHandler` handler for `BeforeShowContextMenuEvent` events.
`HandlerRegistration`	`addBeforeShowHandler(BeforeShowEvent.BeforeShowHandler handler)` Adds a `BeforeShowEvent.BeforeShowHandler` handler for `BeforeShowEvent` events.
`HandlerRegistration`	`addBlurHandler(BlurEvent.BlurHandler handler)` Adds a `BlurEvent.BlurHandler` handler for `BlurEvent` events.
`HandlerRegistration`	`addDisableHandler(DisableEvent.DisableHandler handler)` Adds a `DisableEvent.DisableHandler` handler for `DisableEvent` events.
`HandlerRegistration`	`addEnableHandler(EnableEvent.EnableHandler handler)` Adds a `EnableEvent.EnableHandler` handler for `EnableEvent` events.
`HandlerRegistration`	`addFocusHandler(FocusEvent.FocusHandler handler)` Adds a `FocusEvent.FocusHandler` handler for `FocusEvent` events.
`void`	`addGestureRecognizer(GestureRecognizer gestureRecognizer)` Adds a GestureRecognizer.
`HandlerRegistration`	`addHideHandler(HideEvent.HideHandler handler)` Adds a `HideEvent.HideHandler` handler for `HideEvent` events.
`HandlerRegistration`	`addMoveHandler(MoveEvent.MoveHandler handler)` Adds a `MoveEvent.MoveHandler` handler for `MoveEvent` events.
`HandlerRegistration`	`addResizeHandler(ResizeHandler handler)`
`HandlerRegistration`	`addShowContextMenuHandler(ShowContextMenuEvent.ShowContextMenuHandler handler)` Adds a `ShowContextMenuEvent.ShowContextMenuHandler` handler for `ShowContextMenuEvent` events.
`HandlerRegistration`	`addShowHandler(ShowEvent.ShowHandler handler)` Adds a `ShowEvent.ShowHandler` handler for `ShowEvent` events.
`protected void`	`addStyleDependentName(Element element, String style)` Adds a dependent style name to a child element.
`void`	`addStyleOnOver(Element elem, String style)` Adds a style to the given element on mouseover.
`protected Point`	`adjustPosition(Point point)`
`protected Size`	`adjustSize(Size size)`
`protected void`	`applyState(Map<String,Object> state)`
`protected void`	`assertAfterRender()`
`protected void`	`assertPreRender()`
`protected void`	`blur()` Tries to remove focus from the widget.
`void`	`clearSizeCache()` Clears the size cache (the size of the widget the last time it was changed).
`void`	`disable()` Disable this widget.
`protected void`	`disableContextMenu(boolean disable)` Enables and disables the widget's context menu.
`void`	`disableEvents()` True to disable event processing.
`void`	`enable()` Enable this widget.
`void`	`enableEvents()` True to enable event processing.
`protected boolean`	`fireCancellableEvent(<any> event)`
`void`	`fireEvent(<any> event)`
`void`	`focus()` Try to focus this widget.
`<X> X`	`getData(String key)` Returns the application defined property for the given name, or `null` if it has not been set.
`XElement`	`getElement()` Gets a handle to the object's underlying DOM element.
`protected XElement`	`getFocusEl()`
`FocusManagerSupport`	`getFocusSupport()` Returns the focus manager support configuration.
`GestureRecognizer`	`getGestureRecognizer(int index)` Get GestureRecognizer at given index
`int`	`getGestureRecognizerCount()` Provides the count of GestureRecognizers
`Style.HideMode`	`getHideMode()` Returns the widget's hide mode.
`String`	`getId()` Returns the widget's id.
`String`	`getItemId()` Returns the item id of this widget.
`int`	`getOffsetHeight(boolean content)` Returns the widget's height.
`int`	`getOffsetWidth(boolean content)` Returns the element's width.
`protected XElement`	`getPositionEl()` Returns the element to be used when positioning the widget.
`boolean`	`getShadow()` Returns true if the shadow is enabled.
`Layer.ShadowPosition`	`getShadowPosition()` Returns the shadow position.
`String`	`getStateId()` Returns the widget's state id.
`int`	`getTabIndex()` Returns the current tabIndex of the component.
`ToolTip`	`getToolTip()` Returns the widget's tool tip.
`void`	`hide()` Hide this widget.
`protected void`	`hideShadow()`
`void`	`hideToolTip()` Hides the widget's tool tip (if one exists).
`boolean`	`isAllowTextSelection()` Returns the enable text selection state.
`boolean`	`isAutoHeight()` Returns the auto height state.
`boolean`	`isAutoWidth()` Returns the auto width state.
`boolean`	`isDeferHeight()` Returns true if the height is being deferred
`boolean`	`isEnabled()` Returns `true` if the widget is enabled.
`protected boolean`	`isMonitorWindowResize()` Returns true if browser resizing is monitored
`boolean`	`isRendered()` Returns true if the component has been rendered.
`boolean`	`isStateful()` Returns true if the widget is saving and restore it's state.
`boolean`	`isVisible()`
`boolean`	`isVisible(boolean deep)` Returns `true` if the widget is visible.
`void`	`mask()` Puts a mask over this widget to disable user interaction.
`void`	`mask(String message)` Puts a mask over this widget to disable user interaction.
`protected void`	`notifyHide()`
`protected void`	`notifyShow()`
`protected void`	`onAfterFirstAttach()` Called immediately after the first time the widget becomes attached to the browser's document only the first time.
`protected void`	`onAttach()`
`protected void`	`onBlur(Event event)`
`void`	`onBrowserEvent(Event event)`
`protected void`	`onDetach()`
`protected void`	`onDisable()`
`protected void`	`onEnable()`
`protected void`	`onFocus(Event event)`
`protected void`	`onHide()`
`protected void`	`onHideContextMenu(HideEvent event)`
`protected void`	`onLoad()`
`protected void`	`onPosition(int x, int y)` Called after the widget is moved, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a move occurs.
`protected void`	`onResize(int width, int height)` Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
`protected void`	`onRightClick(Event event)`
`protected void`	`onShow()`
`protected void`	`onShowContextMenu(int clientX, int clientY)`
`protected void`	`onTouch(Event event)`
`protected void`	`onUnload()`
`protected void`	`onWindowResize(int width, int height)`
`protected void`	`removeStyleDependentName(Element element, String style)` Removes a dependent style name from a child element.
`protected void`	`removeStyleOnOver(Element elem)`
`void`	`removeToolTip()` Removes the components tooltip (if one exists).
`void`	`setAllowTextSelection(boolean enable)` Enables and disables text selection for the widget.
`void`	`setBorders(boolean show)` Adds or removes a border.
`void`	`setBounds(int x, int y, int width, int height)` Sets the widget's size.
`void`	`setBounds(Rectangle bounds)` Sets the widget's size.
`void`	`setContextMenu(Menu menu)` Sets the widget's context menu.
`void`	`setData(String key, Object data)` Sets the application defined property with the given name.
`void`	`setDeferHeight(boolean deferHeight)` True to defer height calculations to an external widget, false to allow this widget to set its own height (defaults to false).
`void`	`setEnabled(boolean enabled)` Convenience function for setting disabled/enabled by boolean.
`void`	`setHeight(int height)` Sets the widget's height.
`void`	`setHeight(String height)` Sets the height of the widget.
`void`	`setHideMode(Style.HideMode hideMode)` Sets the components hide mode (defaults to HideMode.DISPLAY).
`void`	`setId(String id)` Sets the component's id.
`void`	`setItemId(String id)` Sets the widget's item id.
`protected void`	`setMonitorWindowResize(boolean monitorWindowResize)` True to have onWindowResize executed when the browser window is resized (default to false).
`void`	`setPagePosition(int x, int y)` Sets the page XY position of the widget.
`void`	`setPixelSize(int width, int height)` Sets the component's size.
`void`	`setPosition(int left, int top)` Sets the left and top of the widget.
`void`	`setShadow(boolean shadow)` True to enable a shadow that will be displayed behind the widget (defaults to false, pre-render).
`void`	`setShadowPosition(Layer.ShadowPosition shadowPosition)` Sets the shadow position (defaults to SIDES, pre-render).
`void`	`setSize(String width, String height)` Sets the width and height of the widget.
`void`	`setStateful(boolean stateful)` A flag which specifies if the component is stateful (defaults to false).
`void`	`setStateId(String stateId)` Sets the widget's state id which is a unique id for this widget to use for state management purposes (defaults to the widget id if one was set, otherwise null if the widget is using a generated id).
`protected void`	`setStyleDependentName(Element element, String style, boolean add)` Adds or removes a dependent style name to a child element.
`void`	`setTabIndex(int tabIndex)` Sets the component's tab index.
`void`	`setToolTip(SafeHtml html)` Sets the widget's tool tip.
`void`	`setToolTipConfig(ToolTipConfig config)` Sets the widget's tool tip with the given config.
`void`	`setVisible(boolean visible)` Convenience function to hide or show this widget by boolean.
`void`	`setWidth(int width)` Sets the width of the widget.
`void`	`setWidth(String width)` Sets the width of the widget.
`void`	`show()` Show this widget.
`void`	`sync(boolean show)` Syncs the layer of the widget.
`void`	`syncSize()` Clears the size cache and resets to the last known size.
`void`	`unmask()` Unmasks the widget.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - adjustSize
```
protected boolean adjustSize
```
    True to adjust sizes for box model issues to ensure actual size matches set size.
  - cacheSizes
```
protected boolean cacheSizes
```
    True to cache size calculation (defaults to true) for better performance.
  - disabled
```
protected boolean disabled
```
    True if the widget is disabled. Read only.
  - disabledStyle
```
protected String disabledStyle
```
    The style used when a widget is disabled (defaults to ThemeStyles.getStyle().disabled()).
  - allowTextSelection
```
protected boolean allowTextSelection
```
  - ensureVisibilityOnSizing
```
protected boolean ensureVisibilityOnSizing
```
    Set this to true if you have sizing issues in initial collapsed or hidden items. It defaults to false for performance reasons. You should not set this to true for all components. If this is enabled than components are made visible for the browser during a call to setSize if they were hidden or collapsed. The user wont see this change. In the end of setSize the status of the widget is reverted again to the normal state. (defaults to false)
  - hidden
```
protected boolean hidden
```
    True if this widget is hidden. Read only.
  - lastSize
```
protected Size lastSize
```
    The size of the widget that last time it was changed.
  - height
```
protected String height
```
  - layer
```
protected Layer layer
```
  - left
```
protected int left
```
  - top
```
protected int top
```
  - mask
```
protected boolean mask
```
  - maskMessage
```
protected String maskMessage
```
  - monitorWindowResize
```
protected boolean monitorWindowResize
```
  - pageX
```
protected int pageX
```
  - pageY
```
protected int pageY
```
  - resizeHandler
```
protected HandlerRegistration resizeHandler
```
  - shim
```
protected boolean shim
```
    True to enable a shim which uses a transparent iframe to stop content from bleeding through.
  - toolTip
```
protected ToolTip toolTip
```
  - toolTipConfig
```
protected ToolTipConfig toolTipConfig
```
  - disableContextMenu
```
protected boolean disableContextMenu
```
  - width
```
protected String width
```
  - windowResizeDelay
```
protected int windowResizeDelay
```
  - windowResizeTask
```
protected DelayedTask windowResizeTask
```
  - tabIndex
```
protected int tabIndex
```
- Constructor Detail
  - Component
```
protected Component()
```
- Method Detail
  - addBeforeHideHandler
```
public HandlerRegistration addBeforeHideHandler(BeforeHideEvent.BeforeHideHandler handler)
```
    Description copied from interface: BeforeHideEvent.HasBeforeHideHandlers
    
    Adds a BeforeHideEvent.BeforeHideHandler handler for BeforeHideEvent events.
    
    Specified by:
    
    addBeforeHideHandler in interface BeforeHideEvent.HasBeforeHideHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addBeforeShowContextMenuHandler
```
public HandlerRegistration addBeforeShowContextMenuHandler(BeforeShowContextMenuEvent.BeforeShowContextMenuHandler handler)
```
    Description copied from interface: BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler
    
    Adds a BeforeShowContextMenuEvent.BeforeShowContextMenuHandler handler for BeforeShowContextMenuEvent events.
    
    Specified by:
    
    addBeforeShowContextMenuHandler in interface BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addBeforeShowHandler
```
public HandlerRegistration addBeforeShowHandler(BeforeShowEvent.BeforeShowHandler handler)
```
    Description copied from interface: BeforeShowEvent.HasBeforeShowHandlers
    
    Adds a BeforeShowEvent.BeforeShowHandler handler for BeforeShowEvent events.
    
    Specified by:
    
    addBeforeShowHandler in interface BeforeShowEvent.HasBeforeShowHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addBlurHandler
```
public HandlerRegistration addBlurHandler(BlurEvent.BlurHandler handler)
```
    Description copied from interface: BlurEvent.HasBlurHandlers
    
    Adds a BlurEvent.BlurHandler handler for BlurEvent events.
    
    Specified by:
    
    addBlurHandler in interface BlurEvent.HasBlurHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addDisableHandler
```
public HandlerRegistration addDisableHandler(DisableEvent.DisableHandler handler)
```
    Description copied from interface: DisableEvent.HasDisableHandlers
    
    Adds a DisableEvent.DisableHandler handler for DisableEvent events.
    
    Specified by:
    
    addDisableHandler in interface DisableEvent.HasDisableHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addEnableHandler
```
public HandlerRegistration addEnableHandler(EnableEvent.EnableHandler handler)
```
    Description copied from interface: EnableEvent.HasEnableHandlers
    
    Adds a EnableEvent.EnableHandler handler for EnableEvent events.
    
    Specified by:
    
    addEnableHandler in interface EnableEvent.HasEnableHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addFocusHandler
```
public HandlerRegistration addFocusHandler(FocusEvent.FocusHandler handler)
```
    Description copied from interface: FocusEvent.HasFocusHandlers
    
    Adds a FocusEvent.FocusHandler handler for FocusEvent events.
    
    Specified by:
    
    addFocusHandler in interface FocusEvent.HasFocusHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addHideHandler
```
public HandlerRegistration addHideHandler(HideEvent.HideHandler handler)
```
    Description copied from interface: HideEvent.HasHideHandlers
    
    Adds a HideEvent.HideHandler handler for HideEvent events.
    
    Specified by:
    
    addHideHandler in interface HideEvent.HasHideHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addMoveHandler
```
public HandlerRegistration addMoveHandler(MoveEvent.MoveHandler handler)
```
    Description copied from interface: MoveEvent.HasMoveHandlers
    
    Adds a MoveEvent.MoveHandler handler for MoveEvent events.
    
    Specified by:
    
    addMoveHandler in interface MoveEvent.HasMoveHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addResizeHandler
```
public HandlerRegistration addResizeHandler(ResizeHandler handler)
```
  - addShowContextMenuHandler
```
public HandlerRegistration addShowContextMenuHandler(ShowContextMenuEvent.ShowContextMenuHandler handler)
```
    Description copied from interface: ShowContextMenuEvent.HasShowContextMenuHandler
    
    Adds a ShowContextMenuEvent.ShowContextMenuHandler handler for ShowContextMenuEvent events.
    
    Specified by:
    
    addShowContextMenuHandler in interface ShowContextMenuEvent.HasShowContextMenuHandler
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addShowHandler
```
public HandlerRegistration addShowHandler(ShowEvent.ShowHandler handler)
```
    Description copied from interface: ShowEvent.HasShowHandlers
    
    Adds a ShowEvent.ShowHandler handler for ShowEvent events.
    
    Specified by:
    
    addShowHandler in interface ShowEvent.HasShowHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addGestureRecognizer
```
public void addGestureRecognizer(GestureRecognizer gestureRecognizer)
```
    Description copied from interface: HasGestureRecognizers
    
    Adds a GestureRecognizer.
    
    Specified by:
    
    addGestureRecognizer in interface HasGestureRecognizers
    
    Parameters:
    
    gestureRecognizer - the gesture recognizer
  - getGestureRecognizer
```
public GestureRecognizer getGestureRecognizer(int index)
```
    Description copied from interface: HasGestureRecognizers
    
    Get GestureRecognizer at given index
    
    Specified by:
    
    getGestureRecognizer in interface HasGestureRecognizers
    
    Parameters:
    
    index - the index you want
    
    Returns:
    
    GestureRecognizer at given index, null if no GestureRecognizers available
  - getGestureRecognizerCount
```
public int getGestureRecognizerCount()
```
    Description copied from interface: HasGestureRecognizers
    
    Provides the count of GestureRecognizers
    
    Specified by:
    
    getGestureRecognizerCount in interface HasGestureRecognizers
    
    Returns:
    
    count
  - addStyleOnOver
```
public void addStyleOnOver(Element elem,
                           String style)
```
    Adds a style to the given element on mouseover. The widget must be sinking mouse events for the over style to function.
    
    Parameters:
    
    elem - the over element
    
    style - the style to add
  - clearSizeCache
```
public void clearSizeCache()
```
    Clears the size cache (the size of the widget the last time it was changed).
  - disable
```
public void disable()
```
    Disable this widget.
  - disableEvents
```
public void disableEvents()
```
    True to disable event processing.
  - enable
```
public void enable()
```
    Enable this widget.
  - enableEvents
```
public void enableEvents()
```
    True to enable event processing.
  - fireEvent
```
public void fireEvent(<any> event)
```
  - focus
```
public void focus()
```
    Try to focus this widget.
  - getData
```
public <X> X getData(String key)
```
    Returns the application defined property for the given name, or null if it has not been set.
    
    Type Parameters:
    
    X - the type of data being returned
    
    Parameters:
    
    key - the name of the property
    
    Returns:
    
    the value or null if it has not been set
  - getElement
```
public XElement getElement()
```
    Gets a handle to the object's underlying DOM element. This method should not be overridden. It is non-final solely to support legacy code that depends upon overriding it. If it is overridden, the subclass implementation must not return a different element than was previously set using #setElement(com.google.gwt.dom.client.Element).
    
    Returns:
    
    the object's browser element
  - getFocusSupport
```
public FocusManagerSupport getFocusSupport()
```
    Returns the focus manager support configuration. Only applicable when the focus manager has been enabled.
    
    Specified by:
    
    getFocusSupport in interface HasFocusSupport
    
    Returns:
    
    the focus manager configuration
  - getHideMode
```
public Style.HideMode getHideMode()
```
    Returns the widget's hide mode.
    
    Returns:
    
    the hide mode
  - setHideMode
```
public void setHideMode(Style.HideMode hideMode)
```
    Sets the components hide mode (defaults to HideMode.DISPLAY).
    
    Parameters:
    
    hideMode - the hide mode.
  - getId
```
public String getId()
```
    Returns the widget's id.
    
    Returns:
    
    the widget id
  - setId
```
public void setId(String id)
```
    Sets the component's id.
    
    Parameters:
    
    id - the id
  - getItemId
```
public String getItemId()
```
    Returns the item id of this widget. Unlike the widget's id, the item id does not have to be unique.
    
    Specified by:
    
    getItemId in interface HasItemId
    
    Returns:
    
    the widget's item id
  - setItemId
```
public void setItemId(String id)
```
    Sets the widget's item id. Unlike a widget's id, the widget's item id is not tied to id attribute of the widget's root element. As such, the item id does not have to be unique.
    
    Specified by:
    
    setItemId in interface HasItemId
    
    Parameters:
    
    id - the item id
  - getOffsetHeight
```
public int getOffsetHeight(boolean content)
```
    Returns the widget's height.
    
    Parameters:
    
    content - true to get the height minus borders and padding
    
    Returns:
    
    the element's height
  - getOffsetWidth
```
public int getOffsetWidth(boolean content)
```
    Returns the element's width.
    
    Parameters:
    
    content - true to get the width minus borders and padding
    
    Returns:
    
    the width
  - getShadow
```
public boolean getShadow()
```
    Returns true if the shadow is enabled.
    
    Returns:
    
    the shadow the shadow state
  - setShadow
```
public void setShadow(boolean shadow)
```
    True to enable a shadow that will be displayed behind the widget (defaults to false, pre-render).
    
    Parameters:
    
    shadow - true to enable the shadow
  - getShadowPosition
```
public Layer.ShadowPosition getShadowPosition()
```
    Returns the shadow position.
    
    Returns:
    
    the shadow position
  - setShadowPosition
```
public void setShadowPosition(Layer.ShadowPosition shadowPosition)
```
    Sets the shadow position (defaults to SIDES, pre-render).
    
    Parameters:
    
    shadowPosition - the position
  - getStateId
```
public String getStateId()
```
    Returns the widget's state id. If a state id is specified, it is used as the key when saving and retrieving the widget's state.
    
    Returns:
    
    the state id
  - setStateId
```
public void setStateId(String stateId)
```
    Sets the widget's state id which is a unique id for this widget to use for state management purposes (defaults to the widget id if one was set, otherwise null if the widget is using a generated id).
    
    Parameters:
    
    stateId - the state id
  - getTabIndex
```
public int getTabIndex()
```
    Returns the current tabIndex of the component. By default this is the tabIndex of the root element, but some subclasses may modify this behavior.
    
    Returns:
    
    the tabIndex of the component
  - setTabIndex
```
public void setTabIndex(int tabIndex)
```
    Sets the component's tab index. Subclasses may override this to set the tab index on a specific element for better focus behavior - they are also responsible for setting the tabIndex field.
    
    Parameters:
    
    tabIndex - the tab index
  - getToolTip
```
public ToolTip getToolTip()
```
    Returns the widget's tool tip.
    
    Returns:
    
    the tool tip
  - hide
```
public void hide()
```
    Hide this widget.
  - hideToolTip
```
public void hideToolTip()
```
    Hides the widget's tool tip (if one exists).
  - isAllowTextSelection
```
public boolean isAllowTextSelection()
```
    Returns the enable text selection state.
    
    Returns:
    
    true if enable, false if disabled
  - setAllowTextSelection
```
public void setAllowTextSelection(boolean enable)
```
    Enables and disables text selection for the widget.
    
    Parameters:
    
    enable - true to enable, false to disable
  - isAutoHeight
```
public boolean isAutoHeight()
```
    Returns the auto height state.
    
    Returns:
    
    the auto height state
  - isAutoWidth
```
public boolean isAutoWidth()
```
    Returns the auto width state.
    
    Returns:
    
    true of auto width
  - isDeferHeight
```
public boolean isDeferHeight()
```
    Returns true if the height is being deferred
    
    Returns:
    
    the defer height state
  - setDeferHeight
```
public void setDeferHeight(boolean deferHeight)
```
    True to defer height calculations to an external widget, false to allow this widget to set its own height (defaults to false).
    
    Parameters:
    
    deferHeight - true to defer height
  - isEnabled
```
public boolean isEnabled()
```
    Returns true if the widget is enabled.
    
    Returns:
    
    the enabled state
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Convenience function for setting disabled/enabled by boolean.
    
    Parameters:
    
    enabled - the enabled state
  - isRendered
```
public boolean isRendered()
```
    Returns true if the component has been rendered.
    
    Returns:
    
    true if rendered
  - isStateful
```
public boolean isStateful()
```
    Returns true if the widget is saving and restore it's state.
    
    Returns:
    
    true if stateful
  - setStateful
```
public void setStateful(boolean stateful)
```
    A flag which specifies if the component is stateful (defaults to false). The widget must have either a setStateId(String) or setId(String) assigned for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a widget.
    
    Parameters:
    
    stateful - true to enable state
  - isVisible
```
public boolean isVisible()
```
  - setVisible
```
public void setVisible(boolean visible)
```
    Convenience function to hide or show this widget by boolean.
    
    Parameters:
    
    visible - the visible state
  - isVisible
```
public boolean isVisible(boolean deep)
```
    Returns true if the widget is visible.
    
    Parameters:
    
    deep - true to search up the widget hierarchy
    
    Returns:
    
    true if the widget is visible
  - mask
```
public void mask()
```
    Puts a mask over this widget to disable user interaction.
  - mask
```
public void mask(String message)
```
    Puts a mask over this widget to disable user interaction.
    
    Parameters:
    
    message - a message to display in the mask
  - onBrowserEvent
```
public void onBrowserEvent(Event event)
```
  - removeToolTip
```
public void removeToolTip()
```
    Removes the components tooltip (if one exists).
  - setBorders
```
public void setBorders(boolean show)
```
    Adds or removes a border.
    
    Parameters:
    
    show - true to display a border
  - setBounds
```
public void setBounds(int x,
                      int y,
                      int width,
                      int height)
```
    Sets the widget's size.
    
    Parameters:
    
    x - the x coordinate
    
    y - the y coordinate
    
    width - the width
    
    height - the height
  - setBounds
```
public void setBounds(Rectangle bounds)
```
    Sets the widget's size.
    
    Parameters:
    
    bounds - the update box
  - setContextMenu
```
public void setContextMenu(Menu menu)
```
    Sets the widget's context menu.
    
    Parameters:
    
    menu - the context menu
  - setData
```
public void setData(String key,
                    Object data)
```
    Sets the application defined property with the given name.
    
    Parameters:
    
    key - the name of the property
    
    data - the new value for the property
  - setHeight
```
public void setHeight(int height)
```
    Sets the widget's height. This method fires the Resize event. element.
    
    Parameters:
    
    height - the new height
  - setHeight
```
public void setHeight(String height)
```
    Sets the height of the widget. This method fires the Resize event. element.
    
    Parameters:
    
    height - the new height to set
  - setPagePosition
```
public void setPagePosition(int x,
                            int y)
```
    Sets the page XY position of the widget. To set the left and top instead, use setPosition(int, int).
    
    Parameters:
    
    x - the x coordinate
    
    y - the y coordinate
  - setPixelSize
```
public void setPixelSize(int width,
                         int height)
```
    Sets the component's size. Unlike GWT widget's, when setting sizes, the component's actual size will match exactly the size specified independent of borders and padding.
    
    Parameters:
    
    width - new width, in pixels
    
    height - height, in pixels
  - setPosition
```
public void setPosition(int left,
                        int top)
```
    Sets the left and top of the widget. To set the page XY position instead, use setPagePosition(int, int).
    
    Parameters:
    
    left - the new left
    
    top - the new top
  - setSize
```
public void setSize(String width,
                    String height)
```
    Sets the width and height of the widget. This method fires the Resize event.
    
    Parameters:
    
    width - the new width to set
    
    height - the new height to set
  - setToolTip
```
public void setToolTip(SafeHtml html)
```
    Sets the widget's tool tip.
    
    Parameters:
    
    html - the tip text or html
  - setToolTipConfig
```
public void setToolTipConfig(ToolTipConfig config)
```
    Sets the widget's tool tip with the given config.
    
    Parameters:
    
    config - the tool tip config
  - setWidth
```
public void setWidth(int width)
```
    Sets the width of the widget. This method fires the Resize event.
    
    Parameters:
    
    width - the new width to set
  - setWidth
```
public void setWidth(String width)
```
    Sets the width of the widget. This method fires the Resize event.
    
    Parameters:
    
    width - the new width to set
  - show
```
public void show()
```
    Show this widget.
  - sync
```
public void sync(boolean show)
```
    Syncs the layer of the widget.
    
    Parameters:
    
    show - true to show the layer
  - syncSize
```
public void syncSize()
```
    Clears the size cache and resets to the last known size.
  - unmask
```
public void unmask()
```
    Unmasks the widget.
  - addStyleDependentName
```
protected void addStyleDependentName(Element element,
                                     String style)
```
    Adds a dependent style name to a child element.
    
    Parameters:
    
    element - the element
    
    style - the style name
  - adjustPosition
```
protected Point adjustPosition(Point point)
```
  - adjustSize
```
protected Size adjustSize(Size size)
```
  - applyState
```
protected void applyState(Map<String,Object> state)
```
  - assertAfterRender
```
protected void assertAfterRender()
```
  - assertPreRender
```
protected void assertPreRender()
```
  - blur
```
protected void blur()
```
    Tries to remove focus from the widget.
  - disableContextMenu
```
protected void disableContextMenu(boolean disable)
```
    Enables and disables the widget's context menu.
    
    Parameters:
    
    disable - true to disable the context menu
  - fireCancellableEvent
```
protected boolean fireCancellableEvent(<any> event)
```
  - getFocusEl
```
protected XElement getFocusEl()
```
  - getPositionEl
```
protected XElement getPositionEl()
```
    Returns the element to be used when positioning the widget. Subclasses may override as needed. Default method returns the widget's root element.
    
    Returns:
    
    the position element
  - hideShadow
```
protected void hideShadow()
```
  - isMonitorWindowResize
```
protected boolean isMonitorWindowResize()
```
    Returns true if browser resizing is monitored
    
    Returns:
    
    true if window resize monitoring is enabled
  - setMonitorWindowResize
```
protected void setMonitorWindowResize(boolean monitorWindowResize)
```
    True to have onWindowResize executed when the browser window is resized (default to false). You need to override onWindowResize to get your needed functionality
    
    Parameters:
    
    monitorWindowResize - true to monitor window resizing
  - notifyHide
```
protected void notifyHide()
```
  - notifyShow
```
protected void notifyShow()
```
  - onAfterFirstAttach
```
protected void onAfterFirstAttach()
```
    Called immediately after the first time the widget becomes attached to the browser's document only the first time.
  - onAttach
```
protected void onAttach()
```
  - onBlur
```
protected void onBlur(Event event)
```
  - onDetach
```
protected void onDetach()
```
  - onDisable
```
protected void onDisable()
```
  - onEnable
```
protected void onEnable()
```
  - onFocus
```
protected void onFocus(Event event)
```
  - onHide
```
protected void onHide()
```
  - onHideContextMenu
```
protected void onHideContextMenu(HideEvent event)
```
  - onLoad
```
protected void onLoad()
```
  - onPosition
```
protected void onPosition(int x,
                          int y)
```
    Called after the widget is moved, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a move occurs.
    
    Parameters:
    
    x - the new x position
    
    y - the new y position
  - onResize
```
protected void onResize(int width,
                        int height)
```
    Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
    
    Parameters:
    
    width - the width
    
    height - the height
  - onRightClick
```
protected void onRightClick(Event event)
```
  - onShow
```
protected void onShow()
```
  - onShowContextMenu
```
protected void onShowContextMenu(int clientX,
                                 int clientY)
```
  - onTouch
```
protected void onTouch(Event event)
```
  - onUnload
```
protected void onUnload()
```
  - onWindowResize
```
protected void onWindowResize(int width,
                              int height)
```
  - removeStyleDependentName
```
protected void removeStyleDependentName(Element element,
                                        String style)
```
    Removes a dependent style name from a child element.
    
    Parameters:
    
    element - the element
    
    style - the style name
  - removeStyleOnOver
```
protected void removeStyleOnOver(Element elem)
```
  - setStyleDependentName
```
protected void setStyleDependentName(Element element,
                                     String style,
                                     boolean add)
```
    Adds or removes a dependent style name to a child element.
    
    Parameters:
    
    element - the element
    
    style - the style name
    
    add - true to add, otherwise remove

Class Component

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

adjustSize

cacheSizes

disabled

disabledStyle

allowTextSelection

ensureVisibilityOnSizing

hidden

lastSize

height

layer

left

top

mask

maskMessage

monitorWindowResize

pageX

pageY

resizeHandler

shim

toolTip

toolTipConfig

disableContextMenu

width

windowResizeDelay

windowResizeTask

tabIndex

Constructor Detail

Component

Method Detail

addBeforeHideHandler

addBeforeShowContextMenuHandler

addBeforeShowHandler

addBlurHandler

addDisableHandler

addEnableHandler

addFocusHandler

addHideHandler

addMoveHandler

addResizeHandler

addShowContextMenuHandler

addShowHandler

addGestureRecognizer

getGestureRecognizer

getGestureRecognizerCount

addStyleOnOver

clearSizeCache

disable

disableEvents

enable

enableEvents

fireEvent

focus

getData

getElement

getFocusSupport

getHideMode

setHideMode

getId

setId

getItemId

setItemId

getOffsetHeight

getOffsetWidth

getShadow

setShadow

getShadowPosition

setShadowPosition

getStateId

setStateId

getTabIndex

setTabIndex

getToolTip

hide

hideToolTip