com.smartgwt.client.widgets.layout

Class NavigationBar

java.lang.Object

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

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

com.smartgwt.client.widgets.BaseWidget

com.smartgwt.client.widgets.Canvas

com.smartgwt.client.widgets.layout.Layout

com.smartgwt.client.widgets.layout.HLayout

com.smartgwt.client.widgets.layout.NavigationBar

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, LogicalStructure, HasClearHandlers, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasDownClickHandlers, HasMembersChangedHandlers, HasNavigationClickHandlers, HasUpClickHandlers

public class NavigationBar
extends HLayout
implements HasDownClickHandlers, HasNavigationClickHandlers, HasUpClickHandlers

Navigation control implemented as a horizontal layout showing back and forward controls and a title.

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

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget

config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
NavigationBar()
NavigationBar(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addDownClickHandler(DownClickHandler handler) Add a downClick handler.
com.google.gwt.event.shared.HandlerRegistration	addNavigationClickHandler(NavigationClickHandler handler) Add a navigationClick handler.
com.google.gwt.event.shared.HandlerRegistration	addUpClickHandler(UpClickHandler handler) Add a upClick handler.
static void	changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren named autoChildName.
static void	changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren named autoChildName.
protected com.google.gwt.core.client.JavaScriptObject	create()
boolean	getAlwaysShowLeftButtonTitle() If set, the left button title will never be omitted in an attempt to fit the full title.
boolean	getAnimateStateChanges() Whether to animate a change of the view state via setViewState().
Canvas	getCustomNavControl() An arbitrary component that will be placed where the miniNavControl AutoChild would normally be placed (see miniNavAlign).
NavigationButton	getLeftButton() The button displayed to the left of the title in this NavigationBar.
java.lang.String	getLeftButtonIcon() Icon for the leftButton.
java.lang.String	getLeftButtonTitle() Title for the leftButton.
com.smartgwt.logicalstructure.core.LogicalStructureObject	getLogicalStructure() Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
int	getMaxCenterOffset() Maximum amount in pixels that the title will be placed off center in an effort to avoid clipping it - see title.
Alignment	getMiniNavAlign() Placement of MiniNavControl, if present: "right" alignment places the miniNav on the far right "center" alignment places the miniNav in the center, or to the right of the title if the title is present "left" alignment will place the miniNav on the left, or to the right of the leftButton if its present.
MiniNavControl	getMiniNavControl() AutoChild of type MiniNavControl.
static NavigationBar	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
NavigationButton	getRightButton() The button displayed to the right of the title in this NavigationBar.
java.lang.String	getRightButtonIcon() Icon for the rightButton.
java.lang.String	getRightButtonTitle() Title for the rightButton.
java.lang.String	getShortLeftButtonTitle() Short title to display for the left button title if there is not enough room to show the title for the navigation bar.
java.lang.Boolean	getShowLeftButton() If set to false, then the leftButton is not shown.
boolean	getShowMiniNavControl() If set to false, then the miniNavControl is not shown.
java.lang.Boolean	getShowRightButton() If set to false, then the rightButton is not shown.
java.lang.String	getTitle() The title to display in the center of this navigation bar.
Label	getTitleLabel() The AutoChild label used to display the title in this NavigationBar.
void	setAlwaysShowLeftButtonTitle(boolean alwaysShowLeftButtonTitle) If set, the left button title will never be omitted in an attempt to fit the full title.
void	setAnimateStateChanges(boolean animateStateChanges) Whether to animate a change of the view state via setViewState().
void	setCustomNavControl(Canvas customNavControl) An arbitrary component that will be placed where the miniNavControl AutoChild would normally be placed (see miniNavAlign).
static void	setDefaultProperties(NavigationBar navigationBarProperties) Class level method to set the default properties of this class.
void	setLeftButtonIcon(java.lang.String leftButtonIcon) Icon for the leftButton.
void	setLeftButtonTitle(java.lang.String leftButtonTitle) Title for the leftButton.
com.smartgwt.logicalstructure.core.LogicalStructureObject	setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.NavigationBarLogicalStructure s) Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
void	setMaxCenterOffset(int maxCenterOffset) Maximum amount in pixels that the title will be placed off center in an effort to avoid clipping it - see title.
void	setMiniNavAlign(Alignment miniNavAlign) Placement of MiniNavControl, if present: "right" alignment places the miniNav on the far right "center" alignment places the miniNav in the center, or to the right of the title if the title is present "left" alignment will place the miniNav on the left, or to the right of the leftButton if its present.
void	setRightButtonIcon(java.lang.String rightButtonIcon) Icon for the rightButton.
void	setRightButtonTitle(java.lang.String rightButtonTitle) Title for the rightButton.
void	setShortLeftButtonTitle(java.lang.String shortLeftButtonTitle) Short title to display for the left button title if there is not enough room to show the title for the navigation bar.
void	setShowLeftButton(java.lang.Boolean showLeftButton) If set to false, then the leftButton is not shown.
void	setShowMiniNavControl(boolean showMiniNavControl) If set to false, then the miniNavControl is not shown.
void	setShowRightButton(java.lang.Boolean showRightButton) If set to false, then the rightButton is not shown.
void	setTitle(java.lang.String title) The title to display in the center of this navigation bar.
void	setViewState(NavigationBarViewState viewState) Sets multiple state attributes of this NavigationBar at once.
void	setViewState(NavigationBarViewState viewState, NavigationDirection direction) Sets multiple state attributes of this NavigationBar at once.

Methods inherited from class com.smartgwt.client.widgets.layout.HLayout

setDefaultProperties, setLogicalStructure

Methods inherited from class com.smartgwt.client.widgets.layout.Layout

addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEditProxyConstructor, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit_Layout, onInit, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, revealChild, revealChild, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEditProxyConstructor, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMember

Methods inherited from class com.smartgwt.client.widgets.Canvas

addChild, addChild, addChild, addChild, addChild, addClearHandler, 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, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoMaskComponents, getAutoParent, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeFonts, resizeFonts, resizeFonts, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

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

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

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

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent

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

NavigationBar

public NavigationBar()

NavigationBar

public NavigationBar(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static NavigationBar getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)

Changes the defaults for Canvas AutoChildren named autoChildName.

Parameters:

autoChildName - name of an AutoChild to customize the defaults for.

defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.

See Also:

AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)

Changes the defaults for FormItem AutoChildren named autoChildName.

Parameters:

autoChildName - name of an AutoChild to customize the defaults for.

defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.

See Also:

AutoChildUsage

create

protected com.google.gwt.core.client.JavaScriptObject create()

Overrides:

create in class HLayout

setAlwaysShowLeftButtonTitle

public void setAlwaysShowLeftButtonTitle(boolean alwaysShowLeftButtonTitle)

If set, the left button title will never be omitted in an attempt to fit the full title. See the documentation of title for details.

If this method is called after the component has been drawn/initialized: Setter for alwaysShowLeftButtonTitle.

Parameters:

alwaysShowLeftButtonTitle - new value for alwaysShowLeftButtonTitle. Default value is false

getAlwaysShowLeftButtonTitle

public boolean getAlwaysShowLeftButtonTitle()

If set, the left button title will never be omitted in an attempt to fit the full title. See the documentation of title for details.

Returns:

Current alwaysShowLeftButtonTitle value. Default value is false

setAnimateStateChanges

public void setAnimateStateChanges(boolean animateStateChanges)
                            throws java.lang.IllegalStateException

Whether to animate a change of the view state via setViewState().

Enabling animation of state changes does have a performance impact because more components need to be created by the NavigationBar to implement the animated transitions. It is therefore recommended to leave animateStateChanges at its default value of false unless setViewState() might be called on this NavigationBar instance and animation is desired.

Note also that when animation is enabled, certain AutoChild defaults and properties may be used to create other AutoChildren that are internal to the animation implementation. This generally does not cause an issue unless certain non-UI event handlers are added to the defaults and/or properties (e.g. Canvas.visibilityChanged(), Canvas.resized()). For those types of handlers, a check should be added to make sure that the handler is running for the expected component.

Note : This is an advanced setting

Parameters:

animateStateChanges - New animateStateChanges value. Default value is false

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

getAnimateStateChanges

public boolean getAnimateStateChanges()

Whether to animate a change of the view state via setViewState().

Enabling animation of state changes does have a performance impact because more components need to be created by the NavigationBar to implement the animated transitions. It is therefore recommended to leave animateStateChanges at its default value of false unless setViewState() might be called on this NavigationBar instance and animation is desired.

Note also that when animation is enabled, certain AutoChild defaults and properties may be used to create other AutoChildren that are internal to the animation implementation. This generally does not cause an issue unless certain non-UI event handlers are added to the defaults and/or properties (e.g. Canvas.visibilityChanged(), Canvas.resized()). For those types of handlers, a check should be added to make sure that the handler is running for the expected component.

Returns:

Current animateStateChanges value. Default value is false

setCustomNavControl

public void setCustomNavControl(Canvas customNavControl)

An arbitrary component that will be placed where the miniNavControl AutoChild would normally be placed (see miniNavAlign).

If this method is called after the component has been drawn/initialized: Setter to update the customNavControl at runtime.

Parameters:

customNavControl - New customNavControl value. Default value is null

getCustomNavControl

public Canvas getCustomNavControl()

An arbitrary component that will be placed where the miniNavControl AutoChild would normally be placed (see miniNavAlign).

Returns:

Current customNavControl value. Default value is null

getLeftButton

public NavigationButton getLeftButton()
                               throws java.lang.IllegalStateException

The button displayed to the left of the title in this NavigationBar. By default this will be a NavigationButton with direction set to NavigationDirection.BACK.

The following passthroughs apply:

• leftButtonTitle for Button.title
• leftButtonIcon for Button.icon

This component is an AutoChild named "leftButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current leftButton value. Default value is null

Throws:

java.lang.IllegalStateException - if this widget has not yet been rendered.

See Also:

getShowLeftButton()

setLeftButtonIcon

public void setLeftButtonIcon(java.lang.String leftButtonIcon)

Icon for the leftButton.

If this method is called after the component has been drawn/initialized: Setter for leftButtonIcon.

Parameters:

leftButtonIcon - new icon for left button. Default value is "[SKIN]back_arrow.png"

See Also:

SCImgURL

getLeftButtonIcon

public java.lang.String getLeftButtonIcon()

Icon for the leftButton.

Returns:

Current leftButtonIcon value. Default value is "[SKIN]back_arrow.png"

See Also:

SCImgURL

setLeftButtonTitle

public void setLeftButtonTitle(java.lang.String leftButtonTitle)

Title for the leftButton.

If this method is called after the component has been drawn/initialized: Setter for leftButtonTitle.

Parameters:

leftButtonTitle - new title HTML for the left button. Default value is null

See Also:

HTMLString

getLeftButtonTitle

public java.lang.String getLeftButtonTitle()

Title for the leftButton.

Returns:

Current leftButtonTitle value. Default value is null

See Also:

HTMLString

setMaxCenterOffset

public void setMaxCenterOffset(int maxCenterOffset)
                        throws java.lang.IllegalStateException

Maximum amount in pixels that the title will be placed off center in an effort to avoid clipping it - see title.

Parameters:

maxCenterOffset - New maxCenterOffset value. Default value is 40

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

getMaxCenterOffset

public int getMaxCenterOffset()

Maximum amount in pixels that the title will be placed off center in an effort to avoid clipping it - see title.

Returns:

Current maxCenterOffset value. Default value is 40

setMiniNavAlign

public void setMiniNavAlign(Alignment miniNavAlign)
                     throws java.lang.IllegalStateException

Placement of MiniNavControl, if present:

• "right" alignment places the miniNav on the far right
• "center" alignment places the miniNav in the center, or to the right of the title if the title is present
• "left" alignment will place the miniNav on the left, or to the right of the leftButton if its present.

Parameters:

miniNavAlign - New miniNavAlign value. Default value is "right"

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

getMiniNavAlign

public Alignment getMiniNavAlign()

Placement of MiniNavControl, if present:

• "right" alignment places the miniNav on the far right
• "center" alignment places the miniNav in the center, or to the right of the title if the title is present
• "left" alignment will place the miniNav on the left, or to the right of the leftButton if its present.

Returns:

Current miniNavAlign value. Default value is "right"

getMiniNavControl

public MiniNavControl getMiniNavControl()
                                 throws java.lang.IllegalStateException

AutoChild of type MiniNavControl. Not shown by default (see showMiniNavControl). Also, if a customNavControl is provided, then the customNavControl is used instead of an automatically created miniNavControl.

This component is an AutoChild named "miniNavControl". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current miniNavControl value. Default value is null

Throws:

java.lang.IllegalStateException - if this widget has not yet been rendered.

getRightButton

public NavigationButton getRightButton()
                                throws java.lang.IllegalStateException

The button displayed to the right of the title in this NavigationBar. By default this will be a NavigationButton with direction set to "forward".

The following passthroughs apply:

• rightButtonTitle for Button.title
• rightButtonIcon for Button.icon

This component is an AutoChild named "rightButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current rightButton value. Default value is null

Throws:

java.lang.IllegalStateException - if this widget has not yet been rendered.

See Also:

getShowRightButton()

setRightButtonIcon

public void setRightButtonIcon(java.lang.String rightButtonIcon)

Icon for the rightButton.

If this method is called after the component has been drawn/initialized: Setter for rightButtonIcon.

Parameters:

rightButtonIcon - new icon for the right button. Default value is null

See Also:

SCImgURL

getRightButtonIcon

public java.lang.String getRightButtonIcon()

Icon for the rightButton.

Returns:

Current rightButtonIcon value. Default value is null

See Also:

SCImgURL

setRightButtonTitle

public void setRightButtonTitle(java.lang.String rightButtonTitle)

Title for the rightButton.

If this method is called after the component has been drawn/initialized: Setter for rightButtonTitle.

Parameters:

rightButtonTitle - new title HTML for the right button. Default value is " "

See Also:

HTMLString

getRightButtonTitle

public java.lang.String getRightButtonTitle()

Title for the rightButton.

Returns:

Current rightButtonTitle value. Default value is " "

See Also:

HTMLString

setShortLeftButtonTitle

public void setShortLeftButtonTitle(java.lang.String shortLeftButtonTitle)

Short title to display for the left button title if there is not enough room to show the title for the navigation bar. Setting to null or an empty string ("") will avoid a shortened title ever being used. See title for a full description.

If this method is called after the component has been drawn/initialized: Setter for shortLeftButtonTitle.

Parameters:

shortLeftButtonTitle - new short title HTML. Default value is "Back"

See Also:

HTMLString

getShortLeftButtonTitle

public java.lang.String getShortLeftButtonTitle()

Short title to display for the left button title if there is not enough room to show the title for the navigation bar. Setting to null or an empty string ("") will avoid a shortened title ever being used. See title for a full description.

Returns:

Current shortLeftButtonTitle value. Default value is "Back"

See Also:

HTMLString

setShowLeftButton

public void setShowLeftButton(java.lang.Boolean showLeftButton)

If set to false, then the leftButton is not shown.

If this method is called after the component has been drawn/initialized: Show or hide the leftButton. The leftButton must be a control of this NavigationBar or else it will still be hidden.

Parameters:

showLeftButton - if false, then the leftButton will be hidden. If unset or true then the leftButton will be shown as long as it is a member of the controls array. Default value is null

getShowLeftButton

public java.lang.Boolean getShowLeftButton()

If set to false, then the leftButton is not shown.

Returns:

Current showLeftButton value. Default value is null

setShowMiniNavControl

public void setShowMiniNavControl(boolean showMiniNavControl)
                           throws java.lang.IllegalStateException

If set to false, then the miniNavControl is not shown.

Parameters:

showMiniNavControl - New showMiniNavControl value. Default value is false

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

getShowMiniNavControl

public boolean getShowMiniNavControl()

If set to false, then the miniNavControl is not shown.

Returns:

Current showMiniNavControl value. Default value is false

setShowRightButton

public void setShowRightButton(java.lang.Boolean showRightButton)

If set to false, then the rightButton is not shown.

If this method is called after the component has been drawn/initialized: Show or hide the rightButton. The rightButton must be a control of this NavigationBar or else it will still be hidden.

Parameters:

showRightButton - if false, then the rightButton will be hidden. If unset or true then the rightButton will be shown as long as it is a member of the controls array. Default value is null

getShowRightButton

public java.lang.Boolean getShowRightButton()

If set to false, then the rightButton is not shown.

Returns:

Current showRightButton value. Default value is null

setTitle

public void setTitle(java.lang.String title)

The title to display in the center of this navigation bar.

If there is not enough room for the title with the current titles of the left and right buttons, space will be used as follows:

• if the title can be fully visible without clipping if it is placed slightly off-center, it will be placed off-center, up to a maximum of maxCenterOffset pixels
• if that's not enough space, if a shortLeftButtonTitle is provided, it will be used in lieu of the normal left button title
• if that's still not enough space, the title of the left button will be hidden, leaving only the icon. This will be skipped if either alwaysShowLeftButtonTitle has been set or the button has no icon, which would leave the space blank.
• if that's still not enough space, the title text will be clipped, showing an ellipsis (where browser support allows this)

If this method is called after the component has been drawn/initialized: Updates the title for this NavigationBar.

Overrides:

setTitle in class Canvas

Parameters:

title - new title HTML. Default value is null

See Also:

HTMLString

getTitle

public java.lang.String getTitle()

The title to display in the center of this navigation bar.

If there is not enough room for the title with the current titles of the left and right buttons, space will be used as follows:

• if the title can be fully visible without clipping if it is placed slightly off-center, it will be placed off-center, up to a maximum of maxCenterOffset pixels
• if that's not enough space, if a shortLeftButtonTitle is provided, it will be used in lieu of the normal left button title
• if that's still not enough space, the title of the left button will be hidden, leaving only the icon. This will be skipped if either alwaysShowLeftButtonTitle has been set or the button has no icon, which would leave the space blank.
• if that's still not enough space, the title text will be clipped, showing an ellipsis (where browser support allows this)

Overrides:

getTitle in class Canvas

Returns:

Current title value. Default value is null

See Also:

HTMLString

getTitleLabel

public Label getTitleLabel()
                    throws java.lang.IllegalStateException

The AutoChild label used to display the title in this NavigationBar.

This component is an AutoChild named "titleLabel". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current titleLabel value. Default value is null

Throws:

java.lang.IllegalStateException - if this widget has not yet been rendered.

addDownClickHandler

public com.google.gwt.event.shared.HandlerRegistration addDownClickHandler(DownClickHandler handler)

Add a downClick handler.

Notification method fired when the down button on the miniNavControl is clicked.

Specified by:

addDownClickHandler in interface HasDownClickHandlers

Parameters:

handler - the downClick handler

Returns:

HandlerRegistration used to remove this handler

addNavigationClickHandler

public com.google.gwt.event.shared.HandlerRegistration addNavigationClickHandler(NavigationClickHandler handler)

Add a navigationClick handler.

Notification method fired when the user clicks the NavigationBar.leftButton or NavigationBar.rightButton

Specified by:

addNavigationClickHandler in interface HasNavigationClickHandlers

Parameters:

handler - the navigationClick handler

Returns:

HandlerRegistration used to remove this handler

setViewState

public void setViewState(NavigationBarViewState viewState)

Sets multiple state attributes of this NavigationBar at once. If this NavigationBar was created with animateStateChanges set to true, then the change-over to the new state attributes will be animated if the direction is either NavigationDirection.FORWARD or NavigationDirection.BACK.

Parameters:

viewState - the new view state.

setViewState

public void setViewState(NavigationBarViewState viewState,
                         NavigationDirection direction)

Sets multiple state attributes of this NavigationBar at once. If this NavigationBar was created with animateStateChanges set to true, then the change-over to the new state attributes will be animated if the direction is either NavigationDirection.FORWARD or NavigationDirection.BACK.

Parameters:

viewState - the new view state.

direction - an optional direction for animation. If not specified or set to NavigationDirection.NONE then the state change will not be animated. The direction should be NavigationDirection.FORWARD for operations that reveal new content and NavigationDirection.BACK for operations that reveal previously-displayed content.

addUpClickHandler

public com.google.gwt.event.shared.HandlerRegistration addUpClickHandler(UpClickHandler handler)

Add a upClick handler.

Notification method fired when the up button on the miniNavControl is clicked.

Specified by:

addUpClickHandler in interface HasUpClickHandlers

Parameters:

handler - the upClick handler

Returns:

HandlerRegistration used to remove this handler

setDefaultProperties

public static void setDefaultProperties(NavigationBar navigationBarProperties)

Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.

Parameters:

navigationBarProperties - properties that should be used as new defaults when instances of this class are created

See Also:

SGWTProperties

setLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.NavigationBarLogicalStructure s)

Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.

getLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()

Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.

Specified by:

getLogicalStructure in interface LogicalStructure

Overrides:

getLogicalStructure in class HLayout