com.smartgwt.client.widgets.tab
Class ImgTab

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.StatefulCanvas
                      extended by com.smartgwt.client.widgets.StretchImg
                          extended by com.smartgwt.client.widgets.StretchImgButton
                              extended by com.smartgwt.client.widgets.tab.ImgTab
All Implemented Interfaces:
HasHandlers, EventListener, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasIconClickHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers

public class ImgTab
extends StretchImgButton

Specialized StretchImgButton used by TabSet/TabBar for tabs


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, isElementSet, scClassName
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
ImgTab()
           
ImgTab(JavaScriptObject jsObj)
           
 
Method Summary
protected  JavaScriptObject create()
           
 Alignment getAlign()
          Alignment of title text
 String getBaseStyle()
          Base CSS style.
 int getCapSize()
          How big are the end pieces by default
static ImgTab getOrCreateRef(JavaScriptObject jsObj)
           
 Boolean getShowFocused()
          Should we visibly change state when the tab recieves keyboard focus?
 Boolean getShowRollOver()
          Should we visibly change state when the mouse goes over this tab
 String getSkinImgDir()
          Base path for the images.
 String getSrc()
          Base URL for tab images
 String getTitleStyle()
          Like titleStyle, can set to provide a separate style for the title text.
 void setAlign(Alignment align)
          Alignment of title text
 void setBaseStyle(String baseStyle)
          Base CSS style.
 void setCapSize(int capSize)
          How big are the end pieces by default
 void setShowFocused(Boolean showFocused)
          Should we visibly change state when the tab recieves keyboard focus?
 void setShowRollOver(Boolean showRollOver)
          Should we visibly change state when the mouse goes over this tab
 void setSkinImgDir(String skinImgDir)
          Base path for the images.
 void setSrc(String src)
          Base URL for tab images
 void setTitleStyle(String titleStyle)
          Like titleStyle, can set to provide a separate style for the title text.
 
Methods inherited from class com.smartgwt.client.widgets.StretchImgButton
action, addIconClickHandler, addToRadioGroup, deselect, getActionType, getAutoFit, getHiliteAccessKey, getIcon, getIconAlign, getIconHeight, getIconOrientation, getIconSize, getIconSpacing, getIconWidth, getLabelBreadthPad, getLabelHPad, getLabelLengthPad, getLabelVPad, getRadioGroup, getSelected, getShowDisabled, getShowDisabledIcon, getShowDown, getShowDownIcon, getShowFocusedIcon, getShowRollOverIcon, getShowSelectedIcon, getShowTitle, getState, getTitle, getValign, getVertical, getWrap, isSelected, removeFromRadioGroup, removeFromRadioGroup, select, setActionType, setAutoFit, setDisabled, setHiliteAccessKey, setIcon, setIconAlign, setIconHeight, setIconOrientation, setIconSize, setIconSpacing, setIconWidth, setLabelBreadthPad, setLabelHPad, setLabelLengthPad, setLabelVPad, setRadioGroup, setSelected, setShowDisabled, setShowDisabledIcon, setShowDown, setShowDownIcon, setShowFocusedIcon, setShowRollOverIcon, setShowSelectedIcon, setShowTitle, setState, setTitle, setValign, setVertical, setWrap
 
Methods inherited from class com.smartgwt.client.widgets.StretchImg
getHSrc, getImageType, getItemBaseStyle, getShowGrip, getVSrc, setHSrc, setImageType, setItemBaseStyle, setShowGrip, setState, setState, setVSrc
 
Methods inherited from class com.smartgwt.client.widgets.StatefulCanvas
getOverCanvasConstructor, getRedrawOnStateChange, getShowFocusedAsOver, getShowOverCanvas, getStateSuffix, setOverCanvasConstructor, setRedrawOnStateChange, setShowFocusedAsOver, setShowOverCanvas
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowTime, getAnimateTime, getAppImgDir, getAutoShowParent, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getLeftAsString, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowResizeBar, getShowShadow, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTooltip, getTop, getTopAsString, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, parentResized, redraw, redraw, removeChild, removeChild, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowTime, setAnimateTime, setAppImgDir, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultWidth, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowResizeBar, setShowShadow, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTooltip, setTop, setTop, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, updateHover, updateHover, updateShadow, visibleAtPoint, visibleAtPoint, willAcceptDrop
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, onInit, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, toString
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addDomHandler, addHandler, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

ImgTab

public ImgTab()

ImgTab

public ImgTab(JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static ImgTab getOrCreateRef(JavaScriptObject jsObj)

create

protected JavaScriptObject create()
Overrides:
create in class StretchImgButton

setCapSize

public void setCapSize(int capSize)
How big are the end pieces by default

Overrides:
setCapSize in class StretchImgButton
Parameters:
capSize - capSize Default value is 2

getCapSize

public int getCapSize()
How big are the end pieces by default

Overrides:
getCapSize in class StretchImgButton
Returns:
int

setSkinImgDir

public void setSkinImgDir(String skinImgDir)
Base path for the images. Note that when used within a TabSet, the tabBarPosition is appended as an additional path segment, yielding "images/Tab/top/" et al.

Overrides:
setSkinImgDir in class Canvas
Parameters:
skinImgDir - skinImgDir Default value is "images/Tab/"

getSkinImgDir

public String getSkinImgDir()
Base path for the images. Note that when used within a TabSet, the tabBarPosition is appended as an additional path segment, yielding "images/Tab/top/" et al.

Overrides:
getSkinImgDir in class Canvas
Returns:
String

setBaseStyle

public void setBaseStyle(String baseStyle)
                  throws IllegalStateException
Description copied from class: StretchImgButton
Base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.

When the component changes state (eg becomes disabled), a suffix will be appended to this style name, reflecting the following states: "Over", "Down", or "Disabled".

If the widget is selected, the suffixes will be "Selected", "SelectedOver", etc.

If the widget has focus and showFocused is true, and showFocusedAsOver is false, the suffixes will be "Focused", "FocusedOver", etc, or if the widget is both selected and focused, "SelectedFocused", "SelectedFocusedOver", etc.

For example, if baseStyle is set to "button", this component is StretchImgButton.isSelected() and the mouse cursor is over this component, the style "buttonSelectedOver" will be used. Sets the base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.

Overrides:
setBaseStyle in class StretchImgButton
Parameters:
baseStyle - baseStyle Default value is "tab"
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getBaseStyle

public String getBaseStyle()
Description copied from class: StretchImgButton
Base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.

When the component changes state (eg becomes disabled), a suffix will be appended to this style name, reflecting the following states: "Over", "Down", or "Disabled".

If the widget is selected, the suffixes will be "Selected", "SelectedOver", etc.

If the widget has focus and showFocused is true, and showFocusedAsOver is false, the suffixes will be "Focused", "FocusedOver", etc, or if the widget is both selected and focused, "SelectedFocused", "SelectedFocusedOver", etc.

For example, if baseStyle is set to "button", this component is StretchImgButton.isSelected() and the mouse cursor is over this component, the style "buttonSelectedOver" will be used.

Overrides:
getBaseStyle in class StretchImgButton
Returns:
String

setTitleStyle

public void setTitleStyle(String titleStyle)
                   throws IllegalStateException
Like titleStyle, can set to provide a separate style for the title text.

If set and the ImgTab is 'vertical', a "v" will be automatically prepended to the style name (hence "tabTitle" -> "vtabTitle").

Overrides:
setTitleStyle in class StretchImgButton
Parameters:
titleStyle - titleStyle Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getTitleStyle

public String getTitleStyle()
Like titleStyle, can set to provide a separate style for the title text.

If set and the ImgTab is 'vertical', a "v" will be automatically prepended to the style name (hence "tabTitle" -> "vtabTitle").

Overrides:
getTitleStyle in class StretchImgButton
Returns:
String

setSrc

public void setSrc(String src)
Base URL for tab images

Overrides:
setSrc in class StretchImgButton
Parameters:
src - src Default value is "tab.gif"

getSrc

public String getSrc()
Base URL for tab images

Overrides:
getSrc in class StretchImgButton
Returns:
String

setShowRollOver

public void setShowRollOver(Boolean showRollOver)
Should we visibly change state when the mouse goes over this tab

Overrides:
setShowRollOver in class StretchImgButton
Parameters:
showRollOver - showRollOver Default value is false

getShowRollOver

public Boolean getShowRollOver()
Should we visibly change state when the mouse goes over this tab

Overrides:
getShowRollOver in class StretchImgButton
Returns:
Boolean

setShowFocused

public void setShowFocused(Boolean showFocused)
Should we visibly change state when the tab recieves keyboard focus?

Overrides:
setShowFocused in class StretchImgButton
Parameters:
showFocused - showFocused Default value is true

getShowFocused

public Boolean getShowFocused()
Should we visibly change state when the tab recieves keyboard focus?

Overrides:
getShowFocused in class StretchImgButton
Returns:
Boolean

setAlign

public void setAlign(Alignment align)
Alignment of title text

Overrides:
setAlign in class StretchImgButton
Parameters:
align - align Default value is Canvas.CENTER

getAlign

public Alignment getAlign()
Alignment of title text

Overrides:
getAlign in class StretchImgButton
Returns:
Alignment