Class NavigationBar
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,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
-
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, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddDownClickHandler(DownClickHandler handler) Add a downClick handler.Add a navigationClick handler.addUpClickHandler(UpClickHandler handler) Add a upClick handler.static voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()booleanIf set, the left button title will never be omitted in an attempt to fit the full title.booleanWhether to animate a change of the view state viasetViewState().An arbitrary component that will be placed where theminiNavControlAutoChild would normally be placed (seeminiNavAlign).The button displayed to the left of the title in this NavigationBar.Iconfor theleftButton.Titlefor theleftButton.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.intMaximum amount in pixels that the title will be placed off center in an effort to avoid clipping it - seetitle.Placement ofMiniNavControl, 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 theleftButtonif its present.AutoChild of typeMiniNavControl.static NavigationBargetOrCreateRef(JavaScriptObject jsObj) The button displayed to the right of the title in this NavigationBar.Iconfor therightButton.Titlefor therightButton.Short title to display for the left button title if there is not enough room to show the title for the navigation bar.If set tofalse, then theleftButtonis not shown.booleanIf set tofalse, then theminiNavControlis not shown.If set tofalse, then therightButtonis not shown.getTitle()The title to display in the center of this navigation bar.The AutoChild label used to display thetitlein this NavigationBar.setAlwaysShowLeftButtonTitle(boolean alwaysShowLeftButtonTitle) If set, the left button title will never be omitted in an attempt to fit the full title.setAnimateStateChanges(boolean animateStateChanges) Whether to animate a change of the view state viasetViewState().voidsetControls(Object... controls) Set of controls to show in the navigation bar.setCustomNavControl(Canvas customNavControl) An arbitrary component that will be placed where theminiNavControlAutoChild would normally be placed (seeminiNavAlign).static voidsetDefaultProperties(NavigationBar navigationBarProperties) Class level method to set the default properties of this class.setIconBaseStyle(String iconBaseStyle) setIconSize(Integer iconSize) setLeftButtonIcon(String leftButtonIcon) Iconfor theleftButton.setLeftButtonTitle(String leftButtonTitle) Titlefor theleftButton.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setMaxCenterOffset(int maxCenterOffset) Maximum amount in pixels that the title will be placed off center in an effort to avoid clipping it - seetitle.setMiniNavAlign(Alignment miniNavAlign) Placement ofMiniNavControl, 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 theleftButtonif its present.setRightButtonIcon(String rightButtonIcon) Iconfor therightButton.setRightButtonTitle(String rightButtonTitle) Titlefor therightButton.setShortLeftButtonTitle(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.setShowLeftButton(Boolean showLeftButton) If set tofalse, then theleftButtonis not shown.setShowMiniNavControl(boolean showMiniNavControl) If set tofalse, then theminiNavControlis not shown.setShowRightButton(Boolean showRightButton) If set tofalse, then therightButtonis not shown.voidThe title to display in the center of this navigation bar.voidsetViewState(NavigationBarViewState viewState) Sets multiple state attributes of thisNavigationBarat once.voidsetViewState(NavigationBarViewState viewState, NavigationDirection direction) Sets multiple state attributes of thisNavigationBarat once.Methods inherited from class com.smartgwt.client.widgets.layout.HLayout
setDefaultProperties, setLogicalStructureMethods 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, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, replaceMember, 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, showMemberMethods 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, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, doValueDictation, doVoiceCommand, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, 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, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, 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, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, 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, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, 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, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, 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, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, 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, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, supportsValueDictation, supportsVoiceCommands, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, 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, getAttributeAsObject, 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, toStringMethods 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, unsinkEventsMethods 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, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
NavigationBar
public NavigationBar() -
NavigationBar
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- 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, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- 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, seeSGWTProperties.- See Also:
-
create
-
setAlwaysShowLeftButtonTitle
If set, the left button title will never be omitted in an attempt to fit the full title. See the documentation oftitlefor details.
If this method is called after the component has been drawn/initialized: Setter foralwaysShowLeftButtonTitle.- Parameters:
alwaysShowLeftButtonTitle- new value foralwaysShowLeftButtonTitle. Default value is false- Returns:
NavigationBarinstance, for chaining setter calls
-
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 oftitlefor details.- Returns:
- Current alwaysShowLeftButtonTitle value. Default value is false
-
setAnimateStateChanges
public NavigationBar setAnimateStateChanges(boolean animateStateChanges) throws IllegalStateException Whether to animate a change of the view state viasetViewState().Enabling animation of state changes does have a performance impact because more components need to be created by the
NavigationBarto implement the animated transitions. It is therefore recommended to leaveanimateStateChangesat its default value offalseunlesssetViewState()might be called on thisNavigationBarinstance 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- Returns:
NavigationBarinstance, for chaining setter calls- Throws:
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 viasetViewState().Enabling animation of state changes does have a performance impact because more components need to be created by the
NavigationBarto implement the animated transitions. It is therefore recommended to leaveanimateStateChangesat its default value offalseunlesssetViewState()might be called on thisNavigationBarinstance 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
-
setIconBaseStyle
A CSS style to apply to images in theleftandrightbuttons. This is a base style supporting suffixes for states, specifically "Over", "Down" and "Disabled", which are applied whenImgButtonsettings likeImgButton.showRollOverIconare applied to the icons.- Parameters:
iconBaseStyle- New iconBaseStyle value. Default value is "icon"- Returns:
NavigationBarinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconBaseStyle
A CSS style to apply to images in theleftandrightbuttons. This is a base style supporting suffixes for states, specifically "Over", "Down" and "Disabled", which are applied whenImgButtonsettings likeImgButton.showRollOverIconare applied to the icons.- Returns:
- Current iconBaseStyle value. Default value is "icon"
- See Also:
-
setIconSize
- Parameters:
iconSize- New iconSize value. Default value is null- Returns:
NavigationBarinstance, for chaining setter calls
-
getIconSize
- Returns:
- Current iconSize value. Default value is null
-
getLeftButton
The button displayed to the left of the title in this NavigationBar. By default this will be aNavigationButtonwithdirectionset toNavigationDirection.BACK.The following
passthroughsapply: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:
IllegalStateException- if this widget has not yet been rendered.- See Also:
-
setLeftButtonIcon
Iconfor theleftButton.
If this method is called after the component has been drawn/initialized: Setter forleftButtonIcon.- Parameters:
leftButtonIcon- new icon for left button. Default value is "[SKIN]back_arrow.png"- Returns:
NavigationBarinstance, for chaining setter calls- See Also:
-
getLeftButtonIcon
Iconfor theleftButton.- Returns:
- Current leftButtonIcon value. Default value is "[SKIN]back_arrow.png"
- See Also:
-
setLeftButtonTitle
Titlefor theleftButton.
If this method is called after the component has been drawn/initialized: Setter forleftButtonTitle.- Parameters:
leftButtonTitle- new title HTML for the left button. Default value is null- Returns:
NavigationBarinstance, for chaining setter calls- See Also:
-
getLeftButtonTitle
Titlefor theleftButton.- Returns:
- Current leftButtonTitle value. Default value is null
- See Also:
-
setMaxCenterOffset
Maximum amount in pixels that the title will be placed off center in an effort to avoid clipping it - seetitle.- Parameters:
maxCenterOffset- New maxCenterOffset value. Default value is 40- Returns:
NavigationBarinstance, for chaining setter calls- Throws:
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 - seetitle.- Returns:
- Current maxCenterOffset value. Default value is 40
-
getRightButton
The button displayed to the right of the title in this NavigationBar. By default this will be aNavigationButtonwithdirectionset to"forward".The following
passthroughsapply: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:
IllegalStateException- if this widget has not yet been rendered.- See Also:
-
setRightButtonIcon
Iconfor therightButton.
If this method is called after the component has been drawn/initialized: Setter forrightButtonIcon.- Parameters:
rightButtonIcon- new icon for the right button. Default value is null- Returns:
NavigationBarinstance, for chaining setter calls- See Also:
-
getRightButtonIcon
Iconfor therightButton.- Returns:
- Current rightButtonIcon value. Default value is null
- See Also:
-
setRightButtonTitle
Titlefor therightButton.
If this method is called after the component has been drawn/initialized: Setter forrightButtonTitle.- Parameters:
rightButtonTitle- new title HTML for the right button. Default value is " "- Returns:
NavigationBarinstance, for chaining setter calls- See Also:
-
getRightButtonTitle
Titlefor therightButton.- Returns:
- Current rightButtonTitle value. Default value is " "
- See Also:
-
setShortLeftButtonTitle
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. Seetitlefor a full description.
If this method is called after the component has been drawn/initialized: Setter forshortLeftButtonTitle.- Parameters:
shortLeftButtonTitle- new short title HTML. Default value is "Back"- Returns:
NavigationBarinstance, for chaining setter calls- See Also:
-
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. Seetitlefor a full description.- Returns:
- Current shortLeftButtonTitle value. Default value is "Back"
- See Also:
-
setShowLeftButton
If set tofalse, then theleftButtonis not shown.
If this method is called after the component has been drawn/initialized: Show or hide theleftButton. TheleftButtonmust be acontrolof thisNavigationBaror else it will still be hidden.- Parameters:
showLeftButton- iffalse, then theleftButtonwill be hidden. If unset ortruethen theleftButtonwill be shown as long as it is a member of thecontrolsarray. Default value is null- Returns:
NavigationBarinstance, for chaining setter calls
-
getShowLeftButton
If set tofalse, then theleftButtonis not shown.- Returns:
- Current showLeftButton value. Default value is null
-
setShowRightButton
If set tofalse, then therightButtonis not shown.
If this method is called after the component has been drawn/initialized: Show or hide therightButton. TherightButtonmust be acontrolof thisNavigationBaror else it will still be hidden.- Parameters:
showRightButton- iffalse, then therightButtonwill be hidden. If unset ortruethen therightButtonwill be shown as long as it is a member of thecontrolsarray. Default value is null- Returns:
NavigationBarinstance, for chaining setter calls
-
getShowRightButton
If set tofalse, then therightButtonis not shown.- Returns:
- Current showRightButton value. Default value is null
-
setTitle
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
leftandrightbuttons, 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
maxCenterOffsetpixels -
if that's not enough space, if a
shortLeftButtonTitleis 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
alwaysShowLeftButtonTitlehas 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 thetitlefor thisNavigationBar. -
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
-
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
leftandrightbuttons, 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
maxCenterOffsetpixels -
if that's not enough space, if a
shortLeftButtonTitleis 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
alwaysShowLeftButtonTitlehas 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 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
-
getTitleLabel
The AutoChild label used to display thetitlein 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:
IllegalStateException- if this widget has not yet been rendered.
-
addDownClickHandler
Add a downClick handler.Notification method fired when the down button on the
miniNavControlis clicked.- Specified by:
addDownClickHandlerin interfaceHasDownClickHandlers- Parameters:
handler- the downClick handler- Returns:
HandlerRegistrationused to remove this handler
-
addUpClickHandler
Add a upClick handler.Notification method fired when the up button on the
miniNavControlis clicked.- Specified by:
addUpClickHandlerin interfaceHasUpClickHandlers- Parameters:
handler- the upClick handler- Returns:
HandlerRegistrationused to remove this handler
-
setControls
Set of controls to show in the navigation bar.The standard set of controls included by default are NavigationBarControls.LEFT_BUTTON, NavigationBarControls.TITLE_LABEL, NavigationBarControls.RIGHT_BUTTON.
Developers may modify the controls to include any Canvases in addition to these standard controls and they will be displayed in the navigation bar.
- Parameters:
controls- to display in the navigation bar.- See Also:
-
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classHLayout
-