public class NavigationBar extends HLayout implements HasDownClickHandlers, HasNavigationClickHandlers, HasUpClickHandlers
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName| Constructor and Description |
|---|
NavigationBar() |
NavigationBar(com.google.gwt.core.client.JavaScriptObject jsObj) |
| 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). |
java.lang.String |
getIconBaseStyle()
|
java.lang.Integer |
getIconSize()
|
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. |
NavigationBar |
setAlwaysShowLeftButtonTitle(boolean alwaysShowLeftButtonTitle)
If set, the left button title will never be omitted in an attempt to fit the full title.
|
NavigationBar |
setAnimateStateChanges(boolean animateStateChanges)
Whether to animate a change of the view state via
setViewState(). |
void |
setControls(java.lang.Object... controls)
Set of controls to show in the navigation bar.
|
NavigationBar |
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.
|
NavigationBar |
setIconBaseStyle(java.lang.String iconBaseStyle)
|
NavigationBar |
setIconSize(java.lang.Integer iconSize)
|
NavigationBar |
setLeftButtonIcon(java.lang.String leftButtonIcon)
Icon for the leftButton. |
NavigationBar |
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. |
NavigationBar |
setMaxCenterOffset(int maxCenterOffset)
Maximum amount in pixels that the title will be placed off center in an effort to avoid clipping it - see
title. |
NavigationBar |
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. |
NavigationBar |
setRightButtonIcon(java.lang.String rightButtonIcon)
Icon for the rightButton. |
NavigationBar |
setRightButtonTitle(java.lang.String rightButtonTitle)
Title for the rightButton. |
NavigationBar |
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.
|
NavigationBar |
setShowLeftButton(java.lang.Boolean showLeftButton)
If set to
false, then the leftButton
is not shown. |
NavigationBar |
setShowMiniNavControl(boolean showMiniNavControl)
If set to
false, then the miniNavControl is not shown. |
NavigationBar |
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. |
setDefaultProperties, setLogicalStructureaddMember, 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, 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, showMemberaddChild, 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, willAcceptDropaddDrawHandler, 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, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventpublic NavigationBar()
public NavigationBar(com.google.gwt.core.client.JavaScriptObject jsObj)
public static NavigationBar getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.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.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.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.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
public NavigationBar setAlwaysShowLeftButtonTitle(boolean alwaysShowLeftButtonTitle)
title for details.
alwaysShowLeftButtonTitle.alwaysShowLeftButtonTitle - new value for alwaysShowLeftButtonTitle. Default value is falseNavigationBar instance, for chaining setter callspublic boolean getAlwaysShowLeftButtonTitle()
title for details.public NavigationBar setAnimateStateChanges(boolean animateStateChanges) throws java.lang.IllegalStateException
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
animateStateChanges - New animateStateChanges value. Default value is falseNavigationBar instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getAnimateStateChanges()
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.
public NavigationBar setCustomNavControl(Canvas customNavControl)
miniNavControl AutoChild would normally be placed
(see miniNavAlign).
customNavControl at runtime.customNavControl - New customNavControl value. Default value is nullNavigationBar instance, for chaining setter callspublic Canvas getCustomNavControl()
miniNavControl AutoChild would normally be placed
(see miniNavAlign).public NavigationBar setIconBaseStyle(java.lang.String iconBaseStyle) throws java.lang.IllegalStateException
left and
right buttons. This is a base style supporting
suffixes for states, specifically "Over", "Down" and "Disabled", which are applied when ImgButton settings like ImgButton.showRollOverIcon are applied to the icons.iconBaseStyle - New iconBaseStyle value. Default value is "icon"NavigationBar instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleNamepublic java.lang.String getIconBaseStyle()
left and
right buttons. This is a base style supporting
suffixes for states, specifically "Over", "Down" and "Disabled", which are applied when ImgButton settings like ImgButton.showRollOverIcon are applied to the icons.CSSStyleNamepublic NavigationBar setIconSize(java.lang.Integer iconSize)
iconSize - New iconSize value. Default value is nullNavigationBar instance, for chaining setter callspublic java.lang.Integer getIconSize()
public NavigationButton getLeftButton() throws java.lang.IllegalStateException
NavigationButton with direction set to NavigationDirection.BACK. The following passthroughs apply:
This component is an AutoChild named "leftButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.getShowLeftButton()public NavigationBar setLeftButtonIcon(java.lang.String leftButtonIcon)
Icon for the leftButton.
leftButtonIcon.leftButtonIcon - new icon for left button. Default value is "[SKIN]back_arrow.png"NavigationBar instance, for chaining setter callsSCImgURLpublic java.lang.String getLeftButtonIcon()
Icon for the leftButton.SCImgURLpublic NavigationBar setLeftButtonTitle(java.lang.String leftButtonTitle)
Title for the leftButton.
leftButtonTitle.leftButtonTitle - new title HTML for the left button. Default value is nullNavigationBar instance, for chaining setter callsHTMLStringpublic java.lang.String getLeftButtonTitle()
Title for the leftButton.HTMLStringpublic NavigationBar setMaxCenterOffset(int maxCenterOffset) throws java.lang.IllegalStateException
title.maxCenterOffset - New maxCenterOffset value. Default value is 40NavigationBar instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic int getMaxCenterOffset()
title.public NavigationBar setMiniNavAlign(Alignment miniNavAlign) throws java.lang.IllegalStateException
MiniNavControl, if present: leftButton if its present. miniNavAlign - New miniNavAlign value. Default value is "right"NavigationBar instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic Alignment getMiniNavAlign()
MiniNavControl, if present: leftButton if its present. public MiniNavControl getMiniNavControl() throws java.lang.IllegalStateException
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.
java.lang.IllegalStateException - if this widget has not yet been rendered.public NavigationButton getRightButton() throws java.lang.IllegalStateException
NavigationButton with direction set to "forward". The following passthroughs
apply:
This component is an AutoChild named "rightButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.getShowRightButton()public NavigationBar setRightButtonIcon(java.lang.String rightButtonIcon)
Icon for the rightButton.
rightButtonIcon.rightButtonIcon - new icon for the right button. Default value is nullNavigationBar instance, for chaining setter callsSCImgURLpublic java.lang.String getRightButtonIcon()
Icon for the rightButton.SCImgURLpublic NavigationBar setRightButtonTitle(java.lang.String rightButtonTitle)
Title for the rightButton.
rightButtonTitle.rightButtonTitle - new title HTML for the right button. Default value is " "NavigationBar instance, for chaining setter callsHTMLStringpublic java.lang.String getRightButtonTitle()
Title for the rightButton.HTMLStringpublic NavigationBar setShortLeftButtonTitle(java.lang.String shortLeftButtonTitle)
title for a full description.
shortLeftButtonTitle.shortLeftButtonTitle - new short title HTML. Default value is "Back"NavigationBar instance, for chaining setter callsHTMLStringpublic java.lang.String getShortLeftButtonTitle()
title for a full description.HTMLStringpublic NavigationBar setShowLeftButton(java.lang.Boolean showLeftButton)
false, then the leftButton
is not shown.
leftButton. The leftButton must be a control of this NavigationBar or else it will still be hidden.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 nullNavigationBar instance, for chaining setter callspublic java.lang.Boolean getShowLeftButton()
false, then the leftButton
is not shown.public NavigationBar setShowMiniNavControl(boolean showMiniNavControl) throws java.lang.IllegalStateException
false, then the miniNavControl is not shown.showMiniNavControl - New showMiniNavControl value. Default value is falseNavigationBar instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic boolean getShowMiniNavControl()
false, then the miniNavControl is not shown.public NavigationBar setShowRightButton(java.lang.Boolean showRightButton)
false, then the rightButton is not shown.
rightButton. The rightButton must be a control of this NavigationBar or else it will still be hidden.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 nullNavigationBar instance, for chaining setter callspublic java.lang.Boolean getShowRightButton()
false, then the rightButton is not shown.public void setTitle(java.lang.String title)
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:
maxCenterOffset pixels shortLeftButtonTitle is provided, it will be used in lieu of the normal left button title alwaysShowLeftButtonTitle has been set or
the button has no icon, which would leave the space blank. title for this NavigationBar.setTitle in class Canvastitle - new title HTML. Default value is nullHTMLStringpublic java.lang.String getTitle()
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:
maxCenterOffset pixels shortLeftButtonTitle is provided, it will be used in lieu of the normal left button title alwaysShowLeftButtonTitle has been set or
the button has no icon, which would leave the space blank. getTitle in class CanvasHTMLStringpublic Label getTitleLabel() throws java.lang.IllegalStateException
title in this
NavigationBar.
This component is an AutoChild named "titleLabel". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public com.google.gwt.event.shared.HandlerRegistration addDownClickHandler(DownClickHandler handler)
Notification method fired when the down button on the miniNavControl is clicked.
addDownClickHandler in interface HasDownClickHandlershandler - the downClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addNavigationClickHandler(NavigationClickHandler handler)
Notification method fired when the user clicks the NavigationBar.leftButton or NavigationBar.rightButton
addNavigationClickHandler in interface HasNavigationClickHandlershandler - the navigationClick handlerHandlerRegistration used to remove this handlerpublic void setViewState(NavigationBarViewState viewState)
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.viewState - the new view state.public void setViewState(NavigationBarViewState viewState, NavigationDirection direction)
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.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.public com.google.gwt.event.shared.HandlerRegistration addUpClickHandler(UpClickHandler handler)
Notification method fired when the up button on the miniNavControl is clicked.
addUpClickHandler in interface HasUpClickHandlershandler - the upClick handlerHandlerRegistration used to remove this handlerpublic static void setDefaultProperties(NavigationBar navigationBarProperties)
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.
navigationBarProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic void setControls(java.lang.Object... controls)
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.
controls - to display in the navigation bar.NavigationBarControlspublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.NavigationBarLogicalStructure s)
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure in interface LogicalStructuregetLogicalStructure in class HLayout