Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.smartgwt.client.widgets.menu
Class Menu

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.grid.ListGrid
                      extended by com.smartgwt.client.widgets.menu.Menu
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, IsWidget, DataBoundComponent, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFetchDataHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasBodyKeyPressHandlers, HasCellClickHandlers, HasCellContextClickHandlers, HasCellDoubleClickHandlers, HasCellHoverHandlers, HasCellMouseDownHandlers, HasCellMouseUpHandlers, HasCellOutHandlers, HasCellOverHandlers, HasCellSavedHandlers, HasDataArrivedHandlers, HasDrawAreaChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFieldStateChangedHandlers, HasFilterEditorSubmitHandlers, HasGroupByHandlers, HasHeaderClickHandlers, HasHeaderDoubleClickHandlers, HasRecordClickHandlers, HasRecordCollapseHandlers, HasRecordDoubleClickHandlers, HasRecordDropHandlers, HasRecordExpandHandlers, HasRowContextClickHandlers, HasRowEditorEnterHandlers, HasRowEditorExitHandlers, HasRowHoverHandlers, HasRowMouseDownHandlers, HasRowMouseUpHandlers, HasRowOutHandlers, HasRowOverHandlers, HasSelectionChangedHandlers, HasSelectionUpdatedHandlers, HasViewStateChangedHandlers, HasItemClickHandlers
public class Menu
extends ListGrid
implements HasItemClickHandlers

The Menu widget class implements interactive menu widgets, with optional icons, submenus, and shortcut keys.

A Menu is initialized with an Array of items, specified as menu.data, each of which represents one row in the menu's display and specifies the action to take when that menu item is selected.

Generally to create a context menu for a component, provide a Menu instance for the contextMenu property. Note that some components have special context menu support because they have distinct regions or because they have a default set of context menu actions available.

If you want a button that pops up a menu when clicked, or a bar of such buttons, see the MenuButton and MenuBar classes.

See Also:
com.smartgwt.client.widgets.menu.Menu#getData, Canvas.getContextMenu(), MenuButton, MenuBar

Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, isElementSet, scClassName
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Menu()
           
Menu(JavaScriptObject jsObj)
           
 
Method Summary
 void addItem(MenuItem item)
           
 void addItem(MenuItem item, int index)
           
 HandlerRegistration addItemClickHandler(ItemClickHandler handler)
          Add a itemClick handler.
protected  JavaScriptObject create()
           
 Boolean getAlternateRecordStyles()
          Explicitly disable alternateRecordStyles at the menu level by default so setting to true for all ListGrids will not impact menus' appearance.
 Boolean getAutoDismiss()
          When false, when a menu item is chosen (via mouse click or keyboard), the menu is not automatically hidden, staying in place for further interactivity
 Boolean getAutoDismissOnBlur()
          When false, when a user clicks outside the menu, or hits the Escape key, this menu will not be automatically hidden, staying in place for further interactivity.
 Boolean getAutoDraw()
          Menus will not draw on initialization, until they're explicitly show()n
 String getBaseStyle()
          CSS style for a normal cell
 Boolean getCanSelectParentItems()
          If true, clicking or pressing Enter on a menu item that has a submenu will select that item (with standard behavior of hiding the menus, calling click handlers, etc) instead of showing the submenu.
 Boolean getCascadeAutoDismiss()
          When true any generated submenus will inherit autoDismiss from this menu.
 int getCellHeight()
          The height of each item in the menu, in pixels.
 int getDefaultWidth()
          The default menu width.
 String getEmptyMessage()
          Message to show when a menu is shown with no items.
 Boolean getFetchSubmenus()
          If false, submenus will not be fetched for this menu.
 int getIconHeight()
          The default height applied to custom icons in this menu.
 int getIconWidth()
          The default width applied to custom icons in this menu.
 MenuItem getItem(int item)
          Get a particular MenuItem by index.
 int getItemNum(MenuItem item)
          Given a MenuItem, return it's index in the items array.
 MenuItem[] getItems()
          Return the menu items.
 Integer getMenuButtonWidth()
          For a menu that has a MenuButton generated for it automatically (for example when included in a MenuBar, the width that the MenuButton should have.
static Menu getOrCreateRef(JavaScriptObject jsObj)
           
 String getShowAnimationEffect()
          When this menu is shown how should it animate into view? By default the menu will just show at the specified size/position.
 Boolean getShowIcons()
          A boolean, indicating whether the checkmark/custom icon column should be displayed.
 Boolean getShowKeys()
          A boolean, indicating whether the shortcut key column should be displayed.
 Boolean getShowSubmenus()
          A boolean, indicating whether the submenu indicator column should be displayed.
 String getSubmenuDirection()
          Should submenus show up on our left or right.
 Canvas getTarget()
          Optional target canvas for this menu.
 Boolean getUseKeys()
          A boolean indicating whether this menu should use shortcut keys.
static void hideAllMenus()
          Hide all menus that are currently open.
 void hideContextMenu()
          Hide the context menu - alias for hide()
protected  void onInit_ListGrid()
           
 void removeItem(MenuItem item)
           
 void setAlternateRecordStyles(Boolean alternateRecordStyles)
          Explicitly disable alternateRecordStyles at the menu level by default so setting to true for all ListGrids will not impact menus' appearance.
 void setAutoDismiss(Boolean autoDismiss)
          When false, when a menu item is chosen (via mouse click or keyboard), the menu is not automatically hidden, staying in place for further interactivity
 void setAutoDismissOnBlur(Boolean autoDismissOnBlur)
          When false, when a user clicks outside the menu, or hits the Escape key, this menu will not be automatically hidden, staying in place for further interactivity.
 void setAutoDraw(Boolean autoDraw)
          Menus will not draw on initialization, until they're explicitly show()n
 void setBaseStyle(String baseStyle)
          CSS style for a normal cell
 void setCanSelectParentItems(Boolean canSelectParentItems)
          If true, clicking or pressing Enter on a menu item that has a submenu will select that item (with standard behavior of hiding the menus, calling click handlers, etc) instead of showing the submenu.
 void setCascadeAutoDismiss(Boolean cascadeAutoDismiss)
          When true any generated submenus will inherit autoDismiss from this menu.
 void setCellHeight(int cellHeight)
          The height of each item in the menu, in pixels.
 void setData(MenuItem... data)
          An array of menuItem objects, specifying the menu items this menu should show.
 void setData(Record[] data)
          An array of Record objects, specifying the data to be used to populate the DataBoundComponent.
 void setData(RecordList data)
          An List of Record objects, specifying the data to be used to populate the DataBoundComponent.
 void setData(Tree data)
          Display a hierarchical set of menu items and submenus based on a Tree of data.
static void setDefaultProperties(Menu menuProperties)
          Class level method to set the default properties of this class.
 void setDefaultWidth(int defaultWidth)
          The default menu width.
 void setEmptyMessage(String emptyMessage)
          Message to show when a menu is shown with no items.
 void setFetchSubmenus(Boolean fetchSubmenus)
          If false, submenus will not be fetched for this menu.
 void setIconHeight(int iconHeight)
          The default height applied to custom icons in this menu.
 void setIconWidth(int iconWidth)
          The default width applied to custom icons in this menu.
 Boolean setItemChecked(int item)
          Checks or unchecks the menu item according to the value of newState, and redraws the menu if necessary.
 Boolean setItemChecked(int item, boolean newState)
          Checks or unchecks the menu item according to the value of newState, and redraws the menu if necessary.
 Boolean setItemChecked(MenuItem item)
          Checks or unchecks the menu item according to the value of newState, and redraws the menu if necessary.
 Boolean setItemChecked(MenuItem item, boolean newState)
          Checks or unchecks the menu item according to the value of newState, and redraws the menu if necessary.
 Boolean setItemEnabled(int item)
          Enables or disables the menu item according to the value of newState, and redraws the menu if necessary.
 Boolean setItemEnabled(int item, boolean newState)
          Enables or disables the menu item according to the value of newState, and redraws the menu if necessary.
 Boolean setItemEnabled(MenuItem item)
          Enables or disables the menu item according to the value of newState, and redraws the menu if necessary.
 Boolean setItemEnabled(MenuItem item, boolean newState)
          Enables or disables the menu item according to the value of newState, and redraws the menu if necessary.
 Boolean setItemIcon(int item, String newIcon)
          Sets the icon and disabled icon (if specified) for a particular menu item and redraws the menu if necessary.
 Boolean setItemIcon(int item, String newIcon, String newDisabledIcon)
          Sets the icon and disabled icon (if specified) for a particular menu item and redraws the menu if necessary.
 Boolean setItemIcon(MenuItem item, String newIcon)
          Sets the icon and disabled icon (if specified) for a particular menu item and redraws the menu if necessary.
 Boolean setItemIcon(MenuItem item, String newIcon, String newDisabledIcon)
          Sets the icon and disabled icon (if specified) for a particular menu item and redraws the menu if necessary.
 void setItemProperties(int item, MenuItem properties)
          Set arbitrary properties for a particular menu item.
 void setItems(MenuItem... items)
          Synonym for data Synonym for setData(com.smartgwt.client.widgets.menu.MenuItem...).
 Boolean setItemTitle(int item, String newTitle)
          Sets the title of a particular menu item to the string specified by newTitle and redraws the menu if necessary.
 Boolean setItemTitle(MenuItem item, String newTitle)
          Sets the title of a particular menu item to the string specified by newTitle and redraws the menu if necessary.
 void setMenuButtonWidth(Integer menuButtonWidth)
          For a menu that has a MenuButton generated for it automatically (for example when included in a MenuBar, the width that the MenuButton should have.
 void setShowAnimationEffect(String showAnimationEffect)
          When this menu is shown how should it animate into view? By default the menu will just show at the specified size/position.
 void setShowIcons(Boolean showIcons)
          A boolean, indicating whether the checkmark/custom icon column should be displayed.
 void setShowKeys(Boolean showKeys)
          A boolean, indicating whether the shortcut key column should be displayed.
 void setShowSubmenus(Boolean showSubmenus)
          A boolean, indicating whether the submenu indicator column should be displayed.
 void setSubmenuDirection(String submenuDirection)
          Should submenus show up on our left or right.
 void setTarget(Canvas target)
          Optional target canvas for this menu.
 void setTitle(String title)
          When used in a MenuBar, the title of the menu button create will be the title of the Menu.
 void setUseKeys(Boolean useKeys)
          A boolean indicating whether this menu should use shortcut keys.
 Boolean showContextMenu()
          Show this menu as a context menu, that is, immediately adjacent to the current mouse position.
 
Methods inherited from class com.smartgwt.client.widgets.grid.ListGrid
addBodyKeyPressHandler, addCellClickHandler, addCellContextClickHandler, addCellDoubleClickHandler, addCellHoverHandler, addCellMouseDownHandler, addCellMouseUpHandler, addCellOutHandler, addCellOverHandler, addCellSavedHandler, addData, addData, addData, addDataArrivedHandler, addDrawAreaChangedHandler, addEditCompleteHandler, addEditFailedHandler, addEditorEnterHandler, addEditorExitHandler, addEmbeddedComponent, addEmbeddedComponent, addFetchDataHandler, addFieldStateChangedHandler, addFilterEditorSubmitHandler, addFormulaField, addGroupByHandler, addHeaderClickHandler, addHeaderDoubleClickHandler, addRecordClickHandler, addRecordCollapseHandler, addRecordDoubleClickHandler, addRecordDropHandler, addRecordExpandHandler, addRowContextClickHandler, addRowEditorEnterHandler, addRowEditorExitHandler, addRowHoverHandler, addRowMouseDownHandler, addRowMouseUpHandler, addRowOutHandler, addRowOverHandler, addSelectionChangedHandler, addSelectionUpdatedHandler, addSort, addSortChangedHandler, addSummaryField, addViewStateChangedHandler, anySelected, autoFitField, autoFitFields, cancelEditing, canEditCell, canExpandRecord, cellHasChanges, cellHasErrors, cellHasErrors, chartData, chartData, clearCriteria, clearCriteria, clearEditValue, clearFieldError, clearFieldError, clearRowErrors, clearSort, closeRecord, collapseRecord, createRecordComponent, deselectAllRecords, deselectRecord, deselectRecord, deselectRecords, deselectRecords, disableHilite, disableHiliting, discardAllEdits, discardAllEdits, discardEdits, discardEdits, editHilites, enableHilite, enableHilite, enableHiliting, enableHiliting, endEditing, expandRecord, exportClientData, exportClientData, exportData, exportData, fetchData, fetchData, fetchData, fetchData, fetchRelatedData, fetchRelatedData, fieldIsVisible, filterByEditor, filterData, filterData, filterData, filterData, focusInFilterEditor, focusInFilterEditor, freezeField, freezeField, freezeFields, freezeFields, getAddDropValues, getAddFormulaFieldText, getAddOperation, getAddSummaryFieldText, getAllEditRows, getAllFields, getAllowFilterExpressions, getAlternateBodyStyleName, getAlternateRecordFrequency, getAlwaysShowEditors, getAnimateFolderEffect, getAnimateFolderMaxRows, getAnimateFolders, getAnimateFolderSpeed, getAnimateFolderTime, getAnimateRemoveRecord, getAnimateRemoveSpeed, getAnimateRemoveTime, getAnimateRollOver, getAnimateRollUnder, getAnimateSelection, getAnimateSelectionUnder, getArrowKeyAction, getAutoFetchAsFilter, getAutoFetchData, getAutoFetchDisplayMap, getAutoFetchTextMatchStyle, getAutoFitAllText, getAutoFitClipFields, getAutoFitData, getAutoFitExpandField, getAutoFitExtraRecords, getAutoFitFieldsFillViewport, getAutoFitFieldText, getAutoFitFieldWidths, getAutoFitIconFields, getAutoFitMaxColumns, getAutoFitMaxHeight, getAutoFitMaxRecords, getAutoFitMaxWidth, getAutoFitWidthApproach, getAutoSaveEdits, getBackgroundComponent, getBaseStyle, getBodyBackgroundColor, getBodyOverflow, getBodyScrollLeft, getBodyScrollTop, getBodyStyleName, getBooleanFalseImage, getBooleanImageHeight, getBooleanImageWidth, getBooleanPartialImage, getBooleanTrueImage, getCanAcceptDroppedRecords, getCanAddFormulaFields, getCanAddSummaryFields, getCanAutoFitFields, getCancelEditingConfirmationMessage, getCanCollapseGroup, getCanDragRecordsOut, getCanDragSelect, getCanDragSelectText, getCanEdit, getCanExpandMultipleRecords, getCanExpandRecordProperty, getCanExpandRecords, getCanFreezeFields, getCanGroupBy, getCanHover, getCanMultiSort, getCanPickFields, getCanPickOmittedFields, getCanRemoveRecords, getCanReorderFields, getCanReorderRecords, getCanResizeFields, getCanSelectAll, getCanSort, getCanTabToHeader, getCellCSSText, getCellErrors, getCellHoverComponent, getCellPadding, getCellStyle, getChartConstructor, getChartType, getCheckboxFieldFalseImage, getCheckboxFieldImageHeight, getCheckboxFieldImageWidth, getCheckboxFieldPartialImage, getCheckboxFieldTrueImage, getChildExpansionMode, getClearAllSortingText, getClearFilterText, getClearSortFieldText, getConfigureSortText, getConfirmCancelEditing, getConfirmDiscardEdits, getConfirmDiscardEditsMessage, getCriteria, getCurrentExpansionComponent, getCurrentExpansionComponent, getDataAsRecordList, getDataFetchMode, getDataPageSize, getDataSource, getDateFormatter, getDatetimeFormatter, getDefaultFields, getDefaultFieldWidth, getDeferRemoval, getDetailDS, getDetailField, getDiscardEditsSaveButtonTitle, getDisplayValue, getDisplayValue, getDisplayValue, getDisplayValue, getDisplayValue, getDragData, getDragDataAction, getDragTrackerMode, getDragTrackerStyle, getDragTrackerTitle, getDrawAheadRatio, getDrawAllMaxCells, getDrawArea, getDrawnRowHeight, getDrawnRows, getDropValues, getDuplicateDragMessage, getEditByCell, getEditCol, getEditedCell, getEditedCell, getEditedCell, getEditedCell, getEditedRecord, getEditEvent, getEditFailedBaseStyle, getEditFailedCSSText, getEditFormItem, getEditFormItem, getEditFormulaFieldText, getEditOnF2Keypress, getEditOnFocus, getEditPendingBaseStyle, getEditPendingCSSText, getEditRow, getEditSummaryFieldText, getEditValue, getEditValue, getEditValueAsBoolean, getEditValueAsDate, getEditValueAsFloat, getEditValueAsInt, getEditValueAsRecord, getEditValueAsRecordArray, getEditValueAsString, getEditValues, getEditValues, getEmptyCellValue, getEmptyMessageStyle, getEnforceVClipping, getEnterKeyEditAction, getEnumCriteriaAsInitialValues, getEscapeKeyEditAction, getEventColumn, getEventColumn, getEventRow, getEventRow, getExpansionCanEdit, getExpansionComponent, getExpansionEditorSaveDialogPrompt, getExpansionFieldFalseImage, getExpansionFieldImageHeight, getExpansionFieldImageWidth, getExpansionFieldTrueImage, getExpansionMode, getExportAll, getExportFields, getExportRawValues, getFetchDelay, getFetchOperation, getField, getField, getFieldName, getFieldName, getFieldNum, getFields, getFieldState, getFieldVisibilitySubmenuTitle, getFieldWidth, getFieldWidth, getFilterButtonPrompt, getFilterByCell, getFilterEditorCriteria, getFilterEditorCriteria, getFilterEditorHeight, getFilterOnKeypress, getFixedFieldWidths, getFixedRecordHeights, getFocusRow, getFormulaFieldValue, getFreezeFieldText, getFreezeOnLeftText, getFreezeOnRightText, getFrozenBaseStyle, getFrozenHeaderBaseStyle, getFrozenHeaderTitleStyle, getGenerateClickOnEnter, getGenerateClickOnSpace, getGenerateDoubleClickOnEnter, getGenerateDoubleClickOnSpace, getGridComponents, getGridRenderer, getGridSummary, getGridSummaryData, getGridSummaryRecordProperty, getGroupByFields, getGroupByFieldSummaries, getGroupByMaxRecords, getGroupByText, getGroupIcon, getGroupIconSize, getGroupIndentSize, getGroupLeadingIndent, getGroupNodeStyle, getGroupSummaryRecordProperty, getGroupSummaryStyle, getGroupTitleColumnProperties, getGroupTitleField, getGroupTree, getHeaderAutoFitEvent, getHeaderBackgroundColor, getHeaderBarStyle, getHeaderBaseStyle, getHeaderContextMenuItems, getHeaderHeight, getHeaderMenuButtonHeight, getHeaderMenuButtonIcon, getHeaderMenuButtonIconHeight, getHeaderMenuButtonIconWidth, getHeaderMenuButtonWidth, getHeaderSpanContextMenuItems, getHeaderSpanHeight, getHeaderTitleStyle, getHiliteProperty, getHilites, getHiliteState, getHoverMode, getHoverStyle, getImageSize, getIncludeInSummaryProperty, getInitialCriteria, getInitialSort, getInstantScrollTrackRedraw, getInvalidSummaryValue, getIsGrouped, getIsSeparatorProperty, getLeaveScrollbarGap, getLinkTextProperty, getListEndEditAction, getLoadingDataMessage, getLoadingDataMessageStyle, getLoadingMessage, getLocateColumnsBy, getLocateRowsBy, getLongTextEditorThreshold, getLongTextEditorType, getMaxExpandedRecords, getMaxExpandedRecordsPrompt, getMinFieldWidth, getModalEditing, getNeverValidate, getNormalBaseStyle, getNormalCellHeight, getNullGroupTitle, getOfflineMessageStyle, getOriginalRecordList, getOriginalResultSet, getPoolComponentsPerColumn, getPreventDuplicates, getPrintAutoFit, getPrintBaseStyle, getPrintHeaderStyle, getPrintMaxRows, getPrintWrapCells, getQuickDrawAheadRatio, getRecord, getRecordBaseStyleProperty, getRecordCanSelectProperty, getRecordComponentHeight, getRecordComponentPoolingMode, getRecordComponentPosition, getRecordDetailDSProperty, getRecordEditProperty, getRecordEnabledProperty, getRecordIndex, getRecordIndex, getRecordList, getRecords, getRecordSummaryBaseStyle, getRelatedDataSource, getRemovedCSSText, getRemoveFieldTitle, getRemoveIcon, getRemoveIconSize, getRemoveOperation, getResizeFieldsInRealTime, getResultSet, getRollOverCanvas, getRollUnderCanvas, getRowEndEditAction, getRowErrors, getRowNumberStart, getRowNumberStyle, getSaveByCell, getSaveLocally, getSaveRequestProperties, getScrollRedrawDelay, getSelectedRecord, getSelectedRecords, getSelectedRecords, getSelectedState, getSelection, getSelection, getSelectionAppearance, getSelectionProperty, getSelectionType, getSelectOnEdit, getShowAllColumns, getShowAllRecords, getShowBackgroundComponent, getShowCellContextMenus, getShowComplexFields, getShowDetailFields, getShowEmptyMessage, getShowFilterEditor, getShowGridSummary, getShowGroupSummary, getShowGroupSummaryInHeader, getShowGroupTitleColumn, getShowHeader, getShowHeaderContextMenu, getShowHeaderMenuButton, getShowHiddenFields, getShowHover, getShowHoverComponents, getShowRecordComponents, getShowRecordComponentsByCell, getShowRollOver, getShowRollOverCanvas, getShowRowNumbers, getShowSelectedStyle, getShowSelectionCanvas, getShowSortArrow, getShowSortNumerals, getShowTreeColumnPicker, getShrinkForFreeze, getSingleCellValueProperty, getSkinImgDir, getSort, getSortAscendingImage, getSortDescendingImage, getSortDirection, getSortField, getSortFieldAscendingText, getSortFieldCount, getSortFieldDescendingText, getSortNumeralHTML, getSortNumeralStyle, getSortSpecifier, getSortState, getStopOnErrors, getStyleName, getSummaryFieldValue, getSummaryRowCriteria, getSummaryRowDataSource, getSummaryRowFetchRequestProperties, getSummaryRowHeight, getSummaryRowStyle, getTallBaseStyle, getTitleField, getTitleFieldValue, getToggleFreezeText, getTotalRows, getTrackerImage, getUnfreezeFieldText, getUngroupText, getUnremoveIcon, getUpdateOperation, getUseAllDataSourceFields, getUseCellRollOvers, getUseFlatFields, getUseRemoteValidators, getValidateByCell, getValidateOnChange, getValueIcon, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getViewState, getVirtualScrolling, getVisibleRows, getWaitForSave, getWarnOnRemoval, getWarnOnRemovalMessage, getWarnOnUnmappedValueFieldChange, getWrapCells, groupBy, hasChanges, hasErrors, hideField, hideField, hideFields, hideFields, hideFields, hideFields, invalidateCache, invalidateRecordComponents, isCheckboxField, isExpansionField, isGrouped, isPartiallySelected, isRowNumberField, isSelected, isSortField, markForRedraw, markForRedraw, markRecordRemoved, markSelectionRemoved, onInit, openRecordDetailGrid, openRecordEditor, preloadImages, recalculateGridSummary, recalculateSummaries, recalculateSummaries, recordMarkedAsRemoved, refreshCell, refreshCell, refreshCellStyle, refreshFields, refreshRecordComponent, refreshRecordComponent, refreshRow, removeData, removeData, removeData, removeEmbeddedComponent, removeEmbeddedComponent, removeEmbeddedComponent, removeRecordClick, removeSelectedData, removeSelectedData, reorderField, reorderFields, resizeField, rowClick, rowDoubleClick, rowHasChanges, rowHasErrors, saveAllEdits, saveAllEdits, saveAllEdits, scrollBodyTo, scrollToRow, selectAllRecords, selectRecord, selectRecord, selectRecord, selectRecord, selectRecords, selectRecords, selectRecords, selectRecords, selectSingleRecord, selectSingleRecord, setAddDropValues, setAddFormulaFieldText, setAddOperation, setAddSummaryFieldText, setAllowFilterExpressions, setAlternateBodyStyleName, setAlternateRecordFrequency, setAlwaysShowEditors, setAnimateFolderEffect, setAnimateFolderMaxRows, setAnimateFolders, setAnimateFolderSpeed, setAnimateFolderTime, setAnimateRemoveRecord, setAnimateRemoveSpeed, setAnimateRemoveTime, setAnimateRollOver, setAnimateRollUnder, setAnimateSelection, setAnimateSelectionUnder, setArrowKeyAction, setAutoFetchAsFilter, setAutoFetchData, setAutoFetchDisplayMap, setAutoFetchTextMatchStyle, setAutoFitAllText, setAutoFitClipFields, setAutoFitData, setAutoFitExpandField, setAutoFitExtraRecords, setAutoFitFieldsFillViewport, setAutoFitFieldText, setAutoFitFieldWidths, setAutoFitIconFields, setAutoFitMaxColumns, setAutoFitMaxHeight, setAutoFitMaxRecords, setAutoFitMaxWidth, setAutoFitWidth, setAutoFitWidthApproach, setAutoSaveEdits, setBackgroundComponent, setBodyBackgroundColor, setBodyOverflow, setBodyStyleName, setBooleanFalseImage, setBooleanImageHeight, setBooleanImageWidth, setBooleanPartialImage, setBooleanTrueImage, setCanAcceptDroppedRecords, setCanAddFormulaFields, setCanAddSummaryFields, setCanAutoFitFields, setCancelEditingConfirmationMessage, setCanCollapseGroup, setCanDragRecordsOut, setCanDragSelect, setCanDragSelectText, setCanEdit, setCanExpandMultipleRecords, setCanExpandRecordProperty, setCanExpandRecords, setCanFreezeFields, setCanGroupBy, setCanHover, setCanMultiSort, setCanPickFields, setCanPickOmittedFields, setCanRemoveRecords, setCanReorderFields, setCanReorderRecords, setCanResizeFields, setCanSelectAll, setCanSort, setCanTabToHeader, setCellFormatter, setCellPadding, setChartConstructor, setChartType, setCheckboxFieldFalseImage, setCheckboxFieldImageHeight, setCheckboxFieldImageWidth, setCheckboxFieldPartialImage, setCheckboxFieldProperties, setCheckboxFieldTrueImage, setChildExpansionMode, setClearAllSortingText, setClearFilterText, setClearSortFieldText, setConfigureSortText, setConfirmCancelEditing, setConfirmDiscardEdits, setConfirmDiscardEditsMessage, setCriteria, setData, setDataFetchMode, setDataPageSize, setDataProperties, setDataSource, setDataSource, setDateFormatter, setDateInputFormat, setDatetimeFormatter, setDefaultFields, setDefaultProperties, setDeferRemoval, setDetailDS, setDetailDS, setDetailField, setDiscardEditsSaveButtonTitle, setDontAutoDestroyComponent, setDragDataAction, setDragTrackerMode, setDragTrackerStyle, setDrawAheadRatio, setDrawAllMaxCells, setDropValues, setDuplicateDragMessage, setEditByCell, setEditEvent, setEditFailedBaseStyle, setEditFailedCSSText, setEditFormulaFieldText, setEditOnF2Keypress, setEditOnFocus, setEditorCustomizer, setEditorValueMap, setEditorValueMap, setEditPendingCSSText, setEditSummaryFieldText, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValues, setEmptyCellValue, setEmptyMessageStyle, setEnforceVClipping, setEnterKeyEditAction, setEnumCriteriaAsInitialValues, setEscapeKeyEditAction, setExpansionCanEdit, setExpansionEditorSaveDialogPrompt, setExpansionFieldFalseImage, setExpansionFieldImageHeight, setExpansionFieldImageWidth, setExpansionFieldTrueImage, setExpansionMode, setExportAll, setExportFields, setExportRawValues, setFastCellUpdates, setFetchDelay, setFetchOperation, setFieldError, setFieldError, setFields, setFieldState, setFieldTitle, setFieldTitle, setFieldVisibilitySubmenuTitle, setFilterButtonPrompt, setFilterButtonProperties, setFilterByCell, setFilterEditorCriteria, setFilterEditorHeight, setFilterOnKeypress, setFixedFieldWidths, setFixedRecordHeights, setFreezeFieldText, setFreezeOnLeftText, setFreezeOnRightText, setFrozenBaseStyle, setFrozenHeaderBaseStyle, setFrozenHeaderTitleStyle, setGenerateClickOnEnter, setGenerateClickOnSpace, setGenerateDoubleClickOnEnter, setGenerateDoubleClickOnSpace, setGridComponents, setGridComponents, setGridSummaryRecordProperty, setGroupByField, setGroupByField, setGroupByFieldSummaries, setGroupByMaxRecords, setGroupByText, setGroupIcon, setGroupIconSize, setGroupIndentSize, setGroupLeadingIndent, setGroupNodeStyle, setGroupStartOpen, setGroupStartOpen, setGroupSummaryRecordProperty, setGroupSummaryStyle, setGroupTitleColumnProperties, setGroupTitleField, setHeaderAutoFitEvent, setHeaderBackgroundColor, setHeaderBarStyle, setHeaderBaseStyle, setHeaderHeight, setHeaderMenuButtonHeight, setHeaderMenuButtonIcon, setHeaderMenuButtonIconHeight, setHeaderMenuButtonIconWidth, setHeaderMenuButtonWidth, setHeaderSpanHeight, setHeaderSpans, setHeaderSpanTitle, setHeaderTitleStyle, setHiliteProperty, setHilites, setHiliteState, setHoverCustomizer, setHoverMode, setHoverStyle, setImageSize, setIncludeInSummaryProperty, setInitialCriteria, setInitialSort, setInstantScrollTrackRedraw, setInvalidSummaryValue, setIsSeparatorProperty, setLeaveHeaderMenuButtonSpace, setLeaveScrollbarGap, setLinkTextProperty, setListEndEditAction, setLoadingDataMessage, setLoadingDataMessageStyle, setLoadingMessage, setLocateColumnsBy, setLocateRowsBy, setLongTextEditorThreshold, setLongTextEditorType, setMaxExpandedRecords, setMaxExpandedRecordsPrompt, setMinFieldWidth, setModalEditing, setNeverValidate, setNormalBaseStyle, setNormalCellHeight, setNullGroupTitle, setOfflineMessageStyle, setPoolComponentsPerColumn, setPreventDuplicates, setPrintAutoFit, setPrintBaseStyle, setPrintHeaderStyle, setPrintMaxRows, setPrintWrapCells, setQuickDrawAheadRatio, setRecordBaseStyleProperty, setRecordCanSelectProperty, setRecordComponentHeight, setRecordComponentPoolingMode, setRecordComponentPosition, setRecordDetailDSProperty, setRecordEditProperty, setRecordEnabledProperty, setRecords, setRecordSummaryBaseStyle, setRemovedCSSText, setRemoveFieldTitle, setRemoveIcon, setRemoveIconSize, setRemoveOperation, setResizeFieldsInRealTime, setRollUnderCanvasProperties, setRowEndEditAction, setRowErrors, setRowNumberFieldProperties, setRowNumberStart, setRowNumberStyle, setSaveByCell, setSaveLocally, setSaveRequestProperties, setScrollRedrawDelay, setSelectedState, setSelectionAppearance, setSelectionCanvasProperties, setSelectionProperty, setSelectionType, setSelectionUnderCanvasProperties, setSelectOnEdit, setShowAllColumns, setShowAllRecords, setShowBackgroundComponent, setShowCellContextMenus, setShowComplexFields, setShowDetailFields, setShowEmptyMessage, setShowFilterEditor, setShowGridSummary, setShowGroupSummary, setShowGroupSummaryInHeader, setShowGroupTitleColumn, setShowHeader, setShowHeaderContextMenu, setShowHeaderMenuButton, setShowHiddenFields, setShowHover, setShowHoverComponents, setShowRecordComponents, setShowRecordComponentsByCell, setShowRollOver, setShowRollOverCanvas, setShowRowNumbers, setShowSelectedStyle, setShowSelectionCanvas, setShowSortArrow, setShowSortNumerals, setShowTreeColumnPicker, setShrinkForFreeze, setSingleCellValueProperty, setSkinImgDir, setSort, setSortAscendingImage, setSortDescendingImage, setSortDirection, setSortField, setSortField, setSortFieldAscendingText, setSortFieldDescendingText, setSortNumeralStyle, setSortState, setStopOnErrors, setStyleName, setSummaryRowCriteria, setSummaryRowDataSource, setSummaryRowFetchRequestProperties, setSummaryRowHeight, setSummaryRowStyle, setTallBaseStyle, setTitleField, setTrackerImage, setUnfreezeFieldText, setUngroupText, setUnremoveIcon, setUpdateOperation, setUseAllDataSourceFields, setUseCellRollOvers, setUseFlatFields, setUseRemoteValidators, setValidateByCell, setValidateOnChange, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setViewState, setVirtualScrolling, setWaitForSave, setWarnOnRemoval, setWarnOnRemovalMessage, setWarnOnUnmappedValueFieldChange, setWrapCells, showField, showField, showFields, showFields, showFields, showFields, showRecordComponent, sort, sort, sort, startEditing, startEditing, startEditingNew, startEditingNew, startEditingNew, stopHover, toggleSort, transferSelectedData, transferSelectedData, unfreezeField, unfreezeField, unfreezeFields, unfreezeFields, ungroup, unmarkRecordRemoved, unsort, updateData, updateData, updateData, updateRecordComponent, validateCell, validateCell, validateRow, willAcceptDrop, willFetchData, willFetchData
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanSelectText, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getFacetId, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowResizeBar, getShowShadow, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTitle, getTooltip, getTop, getTopAsString, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, moveAbove, moveBelow, moveBy, moveTo, parentResized, printComponents, redraw, redraw, removeChild, removeChild, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowResizeBar, setShowShadow, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTooltip, setTop, setTop, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.smartgwt.client.widgets.DataBoundComponent
getOrCreateJsObj
 

Constructor Detail

Menu

public Menu()

Menu

public Menu(JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static Menu getOrCreateRef(JavaScriptObject jsObj)

create

protected JavaScriptObject create()
Overrides:
create in class ListGrid

setAlternateRecordStyles

public void setAlternateRecordStyles(Boolean alternateRecordStyles)
Explicitly disable alternateRecordStyles at the menu level by default so setting to true for all ListGrids will not impact menus' appearance.

Overrides:
setAlternateRecordStyles in class ListGrid
Parameters:
alternateRecordStyles - alternateRecordStyles Default value is false
See Also:
Grid cells Example

getAlternateRecordStyles

public Boolean getAlternateRecordStyles()
Explicitly disable alternateRecordStyles at the menu level by default so setting to true for all ListGrids will not impact menus' appearance.

Overrides:
getAlternateRecordStyles in class ListGrid
Returns:
Boolean
See Also:
Grid cells Example

setAutoDismiss

public void setAutoDismiss(Boolean autoDismiss)
When false, when a menu item is chosen (via mouse click or keyboard), the menu is not automatically hidden, staying in place for further interactivity

Parameters:
autoDismiss - autoDismiss Default value is true
See Also:
setCascadeAutoDismiss(java.lang.Boolean)

getAutoDismiss

public Boolean getAutoDismiss()
When false, when a menu item is chosen (via mouse click or keyboard), the menu is not automatically hidden, staying in place for further interactivity

Returns:
Boolean
See Also:
getCascadeAutoDismiss()

setAutoDismissOnBlur

public void setAutoDismissOnBlur(Boolean autoDismissOnBlur)
When false, when a user clicks outside the menu, or hits the Escape key, this menu will not be automatically hidden, staying in place for further interactivity.

Parameters:
autoDismissOnBlur - autoDismissOnBlur Default value is true

getAutoDismissOnBlur

public Boolean getAutoDismissOnBlur()
When false, when a user clicks outside the menu, or hits the Escape key, this menu will not be automatically hidden, staying in place for further interactivity.

Returns:
Boolean

setAutoDraw

public void setAutoDraw(Boolean autoDraw)
Menus will not draw on initialization, until they're explicitly show()n

Note : This is an advanced setting

Overrides:
setAutoDraw in class Canvas
Parameters:
autoDraw - autoDraw Default value is false
See Also:
Drawing overview and related methods

getAutoDraw

public Boolean getAutoDraw()
Menus will not draw on initialization, until they're explicitly show()n

Overrides:
getAutoDraw in class Canvas
Returns:
Boolean
See Also:
Drawing overview and related methods

setBaseStyle

public void setBaseStyle(String baseStyle)
CSS style for a normal cell

Overrides:
setBaseStyle in class ListGrid
Parameters:
baseStyle - baseStyle Default value is "menu"
See Also:
Appearance overview and related methods

getBaseStyle

public String getBaseStyle()
CSS style for a normal cell

Overrides:
getBaseStyle in class ListGrid
Returns:
String
See Also:
Appearance overview and related methods

setCanSelectParentItems

public void setCanSelectParentItems(Boolean canSelectParentItems)
If true, clicking or pressing Enter on a menu item that has a submenu will select that item (with standard behavior of hiding the menus, calling click handlers, etc) instead of showing the submenu.

Parameters:
canSelectParentItems - canSelectParentItems Default value is null
See Also:
Selection overview and related methods, Tree Binding Example

getCanSelectParentItems

public Boolean getCanSelectParentItems()
If true, clicking or pressing Enter on a menu item that has a submenu will select that item (with standard behavior of hiding the menus, calling click handlers, etc) instead of showing the submenu.

Returns:
Boolean
See Also:
Selection overview and related methods, Tree Binding Example

setCascadeAutoDismiss

public void setCascadeAutoDismiss(Boolean cascadeAutoDismiss)
When true any generated submenus will inherit autoDismiss from this menu.

Parameters:
cascadeAutoDismiss - cascadeAutoDismiss Default value is true

getCascadeAutoDismiss

public Boolean getCascadeAutoDismiss()
When true any generated submenus will inherit autoDismiss from this menu.

Returns:
Boolean

setCellHeight

public void setCellHeight(int cellHeight)
The height of each item in the menu, in pixels.

Overrides:
setCellHeight in class ListGrid
Parameters:
cellHeight - cellHeight Default value is 20
See Also:
Sizing overview and related methods

getCellHeight

public int getCellHeight()
The height of each item in the menu, in pixels.

Overrides:
getCellHeight in class ListGrid
Returns:
int
See Also:
Sizing overview and related methods

setDefaultWidth

public void setDefaultWidth(int defaultWidth)
The default menu width.

Overrides:
setDefaultWidth in class Canvas
Parameters:
defaultWidth - defaultWidth Default value is 150
See Also:
Sizing overview and related methods

getDefaultWidth

public int getDefaultWidth()
The default menu width.

Overrides:
getDefaultWidth in class Canvas
Returns:
int
See Also:
Sizing overview and related methods

setEmptyMessage

public void setEmptyMessage(String emptyMessage)
Message to show when a menu is shown with no items.

Note : This is an advanced setting

Overrides:
setEmptyMessage in class ListGrid
Parameters:
emptyMessage - emptyMessage Default value is "[Empty menu]"
See Also:
ListGrid.setShowEmptyMessage(java.lang.Boolean), ListGrid.setEmptyMessageStyle(java.lang.String), Empty grid Example

getEmptyMessage

public String getEmptyMessage()
Message to show when a menu is shown with no items.

Overrides:
getEmptyMessage in class ListGrid
Returns:
String
See Also:
ListGrid.getShowEmptyMessage(), ListGrid.getEmptyMessageStyle(), Empty grid Example

setFetchSubmenus

public void setFetchSubmenus(Boolean fetchSubmenus)
                      throws IllegalStateException
If false, submenus will not be fetched for this menu. This can be set on a per-item basis via fetchSubmenus.

Parameters:
fetchSubmenus - fetchSubmenus Default value is true
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getFetchSubmenus

public Boolean getFetchSubmenus()
If false, submenus will not be fetched for this menu. This can be set on a per-item basis via fetchSubmenus.

Returns:
Boolean

setIconHeight

public void setIconHeight(int iconHeight)
The default height applied to custom icons in this menu. This is used whenever item.iconHeight is not specified.

Parameters:
iconHeight - iconHeight Default value is 16

getIconHeight

public int getIconHeight()
The default height applied to custom icons in this menu. This is used whenever item.iconHeight is not specified.

Returns:
int

setIconWidth

public void setIconWidth(int iconWidth)
The default width applied to custom icons in this menu. This is used whenever item.iconWidth is not specified.

Parameters:
iconWidth - iconWidth Default value is 16

getIconWidth

public int getIconWidth()
The default width applied to custom icons in this menu. This is used whenever item.iconWidth is not specified.

Returns:
int

setMenuButtonWidth

public void setMenuButtonWidth(Integer menuButtonWidth)
                        throws IllegalStateException
For a menu that has a MenuButton generated for it automatically (for example when included in a MenuBar, the width that the MenuButton should have. If unset, the MenuButton will be as wide as menu.width.

Parameters:
menuButtonWidth - menuButtonWidth Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getMenuButtonWidth

public Integer getMenuButtonWidth()
For a menu that has a MenuButton generated for it automatically (for example when included in a MenuBar, the width that the MenuButton should have. If unset, the MenuButton will be as wide as menu.width.

Returns:
Integer

setShowAnimationEffect

public void setShowAnimationEffect(String showAnimationEffect)
When this menu is shown how should it animate into view? By default the menu will just show at the specified size/position. Options for animated show effects are "fade" to fade from transparent to visible, "slide" to slide the menu into view, or "wipe" to have the menu grow into view, revealing its content as it grows. Can be overridden by passing the 'animationEffect' parameter to 'menu.show()'

Note : This is an advanced setting

Parameters:
showAnimationEffect - showAnimationEffect Default value is null

getShowAnimationEffect

public String getShowAnimationEffect()
When this menu is shown how should it animate into view? By default the menu will just show at the specified size/position. Options for animated show effects are "fade" to fade from transparent to visible, "slide" to slide the menu into view, or "wipe" to have the menu grow into view, revealing its content as it grows. Can be overridden by passing the 'animationEffect' parameter to 'menu.show()'

Returns:
String

setShowIcons

public void setShowIcons(Boolean showIcons)
A boolean, indicating whether the checkmark/custom icon column should be displayed. If showIcons is not set, the menu will show the icon column only if one of its items specifies an icon, checked, checkIf, or dynamicIcon property.

Parameters:
showIcons - showIcons Default value is true

getShowIcons

public Boolean getShowIcons()
A boolean, indicating whether the checkmark/custom icon column should be displayed. If showIcons is not set, the menu will show the icon column only if one of its items specifies an icon, checked, checkIf, or dynamicIcon property.

Returns:
Boolean

setShowKeys

public void setShowKeys(Boolean showKeys)
A boolean, indicating whether the shortcut key column should be displayed. If showKeys is not set, the menu will show the key column only if one of its items specifies a keys property. If showKeys is false, the keys will not be displayed, but will still function.

Parameters:
showKeys - showKeys Default value is true

getShowKeys

public Boolean getShowKeys()
A boolean, indicating whether the shortcut key column should be displayed. If showKeys is not set, the menu will show the key column only if one of its items specifies a keys property. If showKeys is false, the keys will not be displayed, but will still function.

Returns:
Boolean

setShowSubmenus

public void setShowSubmenus(Boolean showSubmenus)
A boolean, indicating whether the submenu indicator column should be displayed. If showSubmenus is not set, the menu will show the indicator column only if one of its items specifies a submenu property. If showSubmenus is false, the submenu arrows will not be displayed, but submenus will still appear on rollover.

Parameters:
showSubmenus - showSubmenus Default value is true

getShowSubmenus

public Boolean getShowSubmenus()
A boolean, indicating whether the submenu indicator column should be displayed. If showSubmenus is not set, the menu will show the indicator column only if one of its items specifies a submenu property. If showSubmenus is false, the submenu arrows will not be displayed, but submenus will still appear on rollover.

Returns:
Boolean

setSubmenuDirection

public void setSubmenuDirection(String submenuDirection)
Should submenus show up on our left or right. Can validly be set to "left" or "right"

Parameters:
submenuDirection - submenuDirection Default value is "right"

getSubmenuDirection

public String getSubmenuDirection()
Should submenus show up on our left or right. Can validly be set to "left" or "right"

Returns:
String

setTarget

public void setTarget(Canvas target)
Optional target canvas for this menu. Available as a parameter to dynamic menuItem configuration methods such as MenuItem.checkIf.

Whenever a Menu is shown as a contextMenu by a widget due to contextMenu being set, menu.target is automatically set to the widget that showed the contextMenu.

If this item has any submenus the target will be propagated down to these child menus.

Parameters:
target - target Default value is null

getTarget

public Canvas getTarget()
Optional target canvas for this menu. Available as a parameter to dynamic menuItem configuration methods such as MenuItem.checkIf.

Whenever a Menu is shown as a contextMenu by a widget due to contextMenu being set, menu.target is automatically set to the widget that showed the contextMenu.

If this item has any submenus the target will be propagated down to these child menus.

Returns:
Canvas

setUseKeys

public void setUseKeys(Boolean useKeys)
A boolean indicating whether this menu should use shortcut keys. Set useKeys to false in a menu's initialization block to explicitly disable shortcut keys.

Parameters:
useKeys - useKeys Default value is true

getUseKeys

public Boolean getUseKeys()
A boolean indicating whether this menu should use shortcut keys. Set useKeys to false in a menu's initialization block to explicitly disable shortcut keys.

Returns:
Boolean

getItem

public MenuItem getItem(int item)
Get a particular MenuItem by index.

If passed a MenuItem, returns it.

Parameters:
item - index of the MenuItem
Returns:
the MenuItem, Pointer to the item, or null if not defined

hideContextMenu

public void hideContextMenu()
Hide the context menu - alias for hide()

Overrides:
hideContextMenu in class Canvas

addItemClickHandler

public HandlerRegistration addItemClickHandler(ItemClickHandler handler)
Add a itemClick handler.

Executed when a menu item with no click handler is clicked by the user. This itemClick handler must be specified as a function. It is passed an item parameter that is a reference to the clicked menu item.

Specified by:
addItemClickHandler in interface HasItemClickHandlers
Parameters:
handler - the itemClick handler
Returns:
HandlerRegistration used to remove this handler

showContextMenu

public Boolean showContextMenu()
Show this menu as a context menu, that is, immediately adjacent to the current mouse position.

Returns:
false == stop processing this event
See Also:
Visibility overview and related methods

hideAllMenus

public static void hideAllMenus()
Hide all menus that are currently open. This method is useful to hide the current set of menus including submenus, and dismiss the menu's clickMask.

setDefaultProperties

public static void setDefaultProperties(Menu menuProperties)
Class level method to set the default properties of this class. If set, then all subsequent instances of this class will automatically have the default properties that were set when this method was called. 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 effect 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.

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

onInit_ListGrid

protected void onInit_ListGrid()
Overrides:
onInit_ListGrid in class ListGrid

setData

public void setData(MenuItem... data)
An array of menuItem objects, specifying the menu items this menu should show.

Parameters:
data - menu items

setData

public void setData(Record[] data)
An array of Record objects, specifying the data to be used to populate the DataBoundComponent. Note that not all DataBoundComponents observe the changes to the data to redraw themselves. Refer to the version of setData that accepts component specific records.

Overrides:
setData in class ListGrid
Parameters:
data - array of Record objects.
See Also:
setData(MenuItem[])

setData

public void setData(Tree data)
Display a hierarchical set of menu items and submenus based on a Tree of data.

Parameters:
data - Tree

setData

public void setData(RecordList data)
An List of Record objects, specifying the data to be used to populate the DataBoundComponent. Note that not all DataBoundComponents observe the changes to the data to redraw themselves. Refer to the version of setData that accepts component specific records.

Overrides:
setData in class ListGrid
Parameters:
data - List of Records

setItems

public void setItems(MenuItem... items)
Synonym for data Synonym for setData(com.smartgwt.client.widgets.menu.MenuItem...).

Parameters:
items - new items for this menu. Default value is null

getItems

public MenuItem[] getItems()
Return the menu items.

Returns:
the menu items

setTitle

public void setTitle(String title)
When used in a MenuBar, the title of the menu button create will be the title of the Menu.

Overrides:
setTitle in class Canvas
Parameters:
title - the title

removeItem

public void removeItem(MenuItem item)

addItem

public void addItem(MenuItem item)

addItem

public void addItem(MenuItem item,
                    int index)

getItemNum

public int getItemNum(MenuItem item)
Given a MenuItem, return it's index in the items array.

Parameters:
item - the MenuItem
Returns:
index of the item, or -1 if not defined.

setItemProperties

public void setItemProperties(int item,
                              MenuItem properties)
Set arbitrary properties for a particular menu item.

Parameters:
item - index of the MenuItem
properties - properties to apply to the item

setItemChecked

public Boolean setItemChecked(MenuItem item)
Checks or unchecks the menu item according to the value of newState, and redraws the menu if necessary. Returns true if there's a change in the checked state.

Parameters:
item - MenuItem in question, or it's index
Returns:
true if the checked state was changed

setItemChecked

public Boolean setItemChecked(int item)
Checks or unchecks the menu item according to the value of newState, and redraws the menu if necessary. Returns true if there's a change in the checked state.

Parameters:
item - MenuItem in question, or it's index
Returns:
true if the checked state was changed

setItemChecked

public Boolean setItemChecked(MenuItem item,
                              boolean newState)
Checks or unchecks the menu item according to the value of newState, and redraws the menu if necessary. Returns true if there's a change in the checked state.

Parameters:
item - MenuItem in question, or it's index
newState - true to check the menu item, false to uncheck it. If not passed, true is assumed
Returns:
true if the checked state was changed

setItemChecked

public Boolean setItemChecked(int item,
                              boolean newState)
Checks or unchecks the menu item according to the value of newState, and redraws the menu if necessary. Returns true if there's a change in the checked state.

Parameters:
item - MenuItem in question, or it's index
newState - true to check the menu item, false to uncheck it. If not passed, true is assumed
Returns:
true if the checked state was changed

setItemEnabled

public Boolean setItemEnabled(MenuItem item)
Enables or disables the menu item according to the value of newState, and redraws the menu if necessary. Returns true if there's a change in the enabled state.

Parameters:
item - MenuItem in question, or it's index
Returns:
true if the enabled state was changed

setItemEnabled

public Boolean setItemEnabled(int item)
Enables or disables the menu item according to the value of newState, and redraws the menu if necessary. Returns true if there's a change in the enabled state.

Parameters:
item - MenuItem in question, or it's index
Returns:
true if the enabled state was changed

setItemEnabled

public Boolean setItemEnabled(MenuItem item,
                              boolean newState)
Enables or disables the menu item according to the value of newState, and redraws the menu if necessary. Returns true if there's a change in the enabled state.

Parameters:
item - MenuItem in question, or it's index
newState - true to enable the menu item, false to disable it. If not passed, true is assumed
Returns:
true if the enabled state was changed

setItemEnabled

public Boolean setItemEnabled(int item,
                              boolean newState)
Enables or disables the menu item according to the value of newState, and redraws the menu if necessary. Returns true if there's a change in the enabled state.

Parameters:
item - MenuItem in question, or it's index
newState - true to enable the menu item, false to disable it. If not passed, true is assumed
Returns:
true if the enabled state was changed

setItemIcon

public Boolean setItemIcon(MenuItem item,
                           String newIcon)
Sets the icon and disabled icon (if specified) for a particular menu item and redraws the menu if necessary. Returns true if the icon changed.

Parameters:
item - MenuItem in question, or it's index
newIcon - new icon URL
Returns:
true == something changed, redraw is called for

setItemIcon

public Boolean setItemIcon(int item,
                           String newIcon)
Sets the icon and disabled icon (if specified) for a particular menu item and redraws the menu if necessary. Returns true if the icon changed.

Parameters:
item - MenuItem in question, or it's index
newIcon - new icon URL
Returns:
true == something changed, redraw is called for

setItemIcon

public Boolean setItemIcon(MenuItem item,
                           String newIcon,
                           String newDisabledIcon)
Sets the icon and disabled icon (if specified) for a particular menu item and redraws the menu if necessary. Returns true if the icon changed.

Parameters:
item - MenuItem in question, or it's index
newIcon - new icon URL
newDisabledIcon - new icon URL for disabled image
Returns:
true == something changed, redraw is called for

setItemIcon

public Boolean setItemIcon(int item,
                           String newIcon,
                           String newDisabledIcon)
Sets the icon and disabled icon (if specified) for a particular menu item and redraws the menu if necessary. Returns true if the icon changed.

Parameters:
item - MenuItem in question, or it's index
newIcon - new icon URL
newDisabledIcon - new icon URL for disabled image
Returns:
true == something changed, redraw is called for

setItemTitle

public Boolean setItemTitle(MenuItem item,
                            String newTitle)
Sets the title of a particular menu item to the string specified by newTitle and redraws the menu if necessary.

Parameters:
item - MenuItem in question, or it's index
newTitle - new title
Returns:
true if the title was changed, and false otherwise

setItemTitle

public Boolean setItemTitle(int item,
                            String newTitle)
Sets the title of a particular menu item to the string specified by newTitle and redraws the menu if necessary.

Parameters:
item - MenuItem in question, or it's index
newTitle - new title
Returns:
true if the title was changed, and false otherwise
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD