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.layout.Layout
                      extended by com.smartgwt.client.widgets.layout.VLayout
                          extended by com.smartgwt.client.widgets.grid.ListGrid
                              extended by com.smartgwt.client.widgets.menu.Menu
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, DataBoundComponent, HasClickHandlers, HasDoubleClickHandlers, HasDragCompleteHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropCompleteHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFetchDataHandlers, HasFocusChangedHandlers, HasFormulaUpdatedHandlers, 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, HasCellSelectionChangedHandlers, HasCellValueHoverHandlers, HasDataArrivedHandlers, HasDrawAreaChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFieldStateChangedHandlers, HasFilterEditorSubmitHandlers, HasGroupByCompleteHandlers, HasGroupByHandlers, HasGroupStateChangedHandlers, HasHeaderClickHandlers, HasHeaderDoubleClickHandlers, HasHeaderHoverHandlers, HasHilitesChangedHandlers, HasRecordClickHandlers, HasRecordCollapseHandlers, HasRecordDoubleClickHandlers, HasRecordDropHandlers, HasRecordExpandHandlers, HasRemoveRecordClickHandlers, HasRowContextClickHandlers, HasRowEditorEnterHandlers, HasRowEditorExitHandlers, HasRowHoverHandlers, HasRowMouseDownHandlers, HasRowMouseUpHandlers, HasRowOutHandlers, HasRowOverHandlers, HasSelectionChangedHandlers, HasSelectionUpdatedHandlers, HasSortChangedHandlers, HasSorterClickHandlers, HasSorterContextClickHandlers, HasViewStateChangedHandlers, HasMembersChangedHandlers, HasItemClickHandlers
Direct Known Subclasses:
MenuPalette

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
static ListGridField ICON_FIELD
           
static ListGridField KEY_FIELD
           
static ListGridField SUBMENU_FIELD
           
static ListGridField TITLE_FIELD
           
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, nativeObject, 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.
static void changeAutoChildDefaults(String autoChildName, Canvas defaults)
          Changes the defaults for Canvas AutoChildren named autoChildName.
static void changeAutoChildDefaults(String autoChildName, FormItem defaults)
          Changes the defaults for FormItem AutoChildren named autoChildName.
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
 String getBodyStyleName()
          CSS style used for the body of this menu when there is no icon field.
 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.
 Img getCheckmarkDisabledImage()
          Default image to display for disabled checkmarked items.
 Img getCheckmarkImage()
          Default image to display for checkmarked items.
 DataSource getDataSource()
          Optional DataSource to fetch menuItems and submenus from, instead of using items.
 int getDefaultWidth()
          The default menu width.
 String getEmptyMessage()
          Message to show when a menu is shown with no items.
 Boolean getFetchSubmenus()
          When using a Tree or hierarchical DataSource as the menu's data, submenus are automatically generated from child nodes.
 String getIconBodyStyleName()
          If set, the CSS style used for the body of this menu when there is an icon field.
 ListGridField getIconFieldDefaults()
          Default properties for the automatically generated icon column.
 ListGridField getIconFieldProperties()
          Custom properties for the automatically generated icon column.
 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.
 ListGridField getKeyFieldDefaults()
          Default properties for the automatically generated icon column.
 ListGridField getKeyFieldProperties()
          Custom properties for the automatically generated key column.
 com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
           
 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.
 JavaScriptObject getOrCreateJsObj()
           
static Menu getOrCreateRef(JavaScriptObject jsObj)
           
static Menu getOrCreateRef(JavaScriptObject jsObj, MenuItem parentItem)
           
 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.
 Menu getSubmenu(MenuItem item)
          Creates and returns the submenu associated with the provided MenuItem.
 String getSubmenuConstructor()
          When using a Tree or hierarchical DataSource as the menu's data, optional subclass of Menu that should be used when generating submenus.
 String getSubmenuDirection()
          Should submenus show up on our left or right.
 Img getSubmenuDisabledImage()
          Default image to use for the submenu indicator when item is disabled.
 ListGridField getSubmenuFieldDefaults()
          Default properties for the automatically generated submenu column.
 ListGridField getSubmenuFieldProperties()
          Custom properties for the automatically generated submenu column.
 Img getSubmenuImage()
          Default image to use for the submenu indicator.
 Canvas getTarget()
          Optional target canvas for this menu.
protected  Menu getTestInstance()
           
 ListGridField getTitleFieldDefaults()
          Default properties for the automatically generated title column.
 ListGridField getTitleFieldProperties()
          Custom properties for the automatically generated title column.
 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 relinkJavaScriptObject(JavaScriptObject jsObj)
           
 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 setBodyStyleName(String bodyStyleName)
          CSS style used for the body of this menu when there is no icon field.
 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 setCheckmarkDisabledImage(Img checkmarkDisabledImage)
          Default image to display for disabled checkmarked items.
 void setCheckmarkImage(Img checkmarkImage)
          Default image to display for checkmarked items.
 void setConfig(JavaScriptObject config)
           
 void setData(MenuItem... data)
          An array of menuItem objects, specifying the menu items this menu should show.
 void setData(Record[] data)
          An array of menuItem objects, specifying the menu items this menu should show.
 void setData(RecordList data)
          An array of menuItem objects, specifying the menu items this menu should show.
 void setData(Tree data)
          An array of menuItem objects, specifying the menu items this menu should show.
 void setDataProperties(Tree dataProperties)
          For a Menu that uses a DataSource, these properties will be passed to the automatically-created ResultTree.
 void setDataSource(DataSource dataSource)
          Optional DataSource to fetch menuItems and submenus from, instead of using items.
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)
          When using a Tree or hierarchical DataSource as the menu's data, submenus are automatically generated from child nodes.
 void setIconBodyStyleName(String iconBodyStyleName)
          If set, the CSS style used for the body of this menu when there is an icon field.
 void setIconFieldDefaults(ListGridField iconFieldDefaults)
          Default properties for the automatically generated icon column.
 void setIconFieldProperties(ListGridField iconFieldProperties)
          Custom properties for the automatically generated icon column.
 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

If this method is called after the component has been drawn/initialized: Synonym for Menu.setData.
 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 setKeyFieldDefaults(ListGridField keyFieldDefaults)
          Default properties for the automatically generated icon column.
 void setKeyFieldProperties(ListGridField keyFieldProperties)
          Custom properties for the automatically generated key column.
 com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.menu.MenuLogicalStructure s)
           
 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 setSubmenuConstructor(String submenuConstructor)
          When using a Tree or hierarchical DataSource as the menu's data, optional subclass of Menu that should be used when generating submenus.
 void setSubmenuDirection(String submenuDirection)
          Should submenus show up on our left or right.
 void setSubmenuDisabledImage(Img submenuDisabledImage)
          Default image to use for the submenu indicator when item is disabled.
 void setSubmenuFieldDefaults(ListGridField submenuFieldDefaults)
          Default properties for the automatically generated submenu column.
 void setSubmenuFieldProperties(ListGridField submenuFieldProperties)
          Custom properties for the automatically generated submenu column.
 void setSubmenuImage(Img submenuImage)
          Default image to use for the submenu indicator.
 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 setTitleFieldDefaults(ListGridField titleFieldDefaults)
          Default properties for the automatically generated title column.
 void setTitleFieldProperties(ListGridField titleFieldProperties)
          Custom properties for the automatically generated title column.
 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, addCellSelectionChangedHandler, addCellValueHoverHandler, addData, addData, addData, addDataArrivedHandler, addDragCompleteHandler, addDrawAreaChangedHandler, addDropCompleteHandler, addEditCompleteHandler, addEditFailedHandler, addEditorEnterHandler, addEditorExitHandler, addEmbeddedComponent, addEmbeddedComponent, addEmbeddedComponent, addEmbeddedComponent, addFetchDataHandler, addFieldStateChangedHandler, addFilterEditorSubmitHandler, addFormulaField, addFormulaUpdatedHandler, addGroupByCompleteHandler, addGroupByHandler, addGroupStateChangedHandler, addHeaderClickHandler, addHeaderDoubleClickHandler, addHeaderHoverHandler, addHilitesChangedHandler, addRecordClickHandler, addRecordCollapseHandler, addRecordDoubleClickHandler, addRecordDropHandler, addRecordExpandHandler, addRemoveRecordClickHandler, addRowContextClickHandler, addRowEditorEnterHandler, addRowEditorExitHandler, addRowHoverHandler, addRowMouseDownHandler, addRowMouseUpHandler, addRowOutHandler, addRowOverHandler, addSelectionChangedHandler, addSelectionUpdatedHandler, addSort, addSortChangedHandler, addSorterClickHandler, addSorterContextClickHandler, addSummaryField, addViewStateChangedHandler, anySelected, applyCellData, applyRecordData, autoFitField, autoFitFields, autoFitFields, cancelEditing, canEditCell, canExpandRecord, canSelectCell, canSelectRecord, cellHasChanges, cellHasErrors, cellHasErrors, cellValueHoverHTML, cellValueIsClipped, chartData, chartData, chartData, chartData, chartData, clearCriteria, clearCriteria, clearCriteria, clearEditValue, clearFieldError, clearFieldError, clearRowErrors, clearSort, closeRecord, collapseRecord, collapseRecords, configureGrouping, createRecordComponent, deselectAllRecords, deselectRange, deselectRecord, deselectRecord, deselectRecords, deselectRecords, disableHilite, disableHiliting, discardAllEdits, discardAllEdits, discardAllEdits, discardEdits, discardEdits, displayHeaderContextMenu, editFields, editHilites, enableHilite, enableHilite, enableHiliting, enableHiliting, endEditing, expandRecord, expandRecords, exportClientData, exportClientData, exportClientData, exportData, exportData, fetchData, fetchData, fetchData, fetchData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fieldIsVisible, filterByEditor, filterData, filterData, filterData, filterData, find, findAll, findIndex, findNextIndex, findNextIndex, focusInCell, focusInFilterEditor, focusInFilterEditor, focusInRow, freezeField, freezeField, freezeField, freezeField, freezeFields, freezeFields, getAddDropValues, getAddFormulaFieldText, getAddOperation, getAddSummaryFieldText, getAdvancedFieldPickerThreshold, getAllEditRows, getAllFields, getAllowFilterExpressions, getAllowRowSpanning, getAlternateBodyStyleName, getAlternateFieldFrequency, getAlternateFieldStyles, getAlternateRecordFrequency, getAlwaysShowEditors, getAnimateFolderEffect, getAnimateFolderMaxRows, getAnimateFolders, getAnimateFolderSpeed, getAnimateFolderTime, getAnimateRemoveRecord, getAnimateRemoveSpeed, getAnimateRemoveTime, getAnimateRollOver, getAnimateRollUnder, getAnimateSelection, getAnimateSelectionUnder, getApplyFormulaAfterSummary, getApplyRowNumberStyle, getArrowKeyAction, getAsynchGroupingPrompt, getAutoFetchAsFilter, getAutoFetchData, getAutoFetchDisplayMap, getAutoFetchTextMatchStyle, getAutoFitAllText, getAutoFitClipFields, getAutoFitData, getAutoFitExpandField, getAutoFitExtraRecords, getAutoFitFieldsFillViewport, getAutoFitFieldText, getAutoFitFieldWidths, getAutoFitHeaderHeights, getAutoFitIconFields, getAutoFitMaxColumns, getAutoFitMaxHeight, getAutoFitMaxRecords, getAutoFitMaxWidth, getAutoFitWidthApproach, getAutoSaveEdits, getAutoSizeHeaderSpans, getBackgroundComponent, getBadFormulaResultValue, getBaseStyle, getBody, getBodyBackgroundColor, getBodyOverflow, getBodyScrollLeft, getBodyScrollTop, getBooleanBaseStyle, getBooleanFalseImage, getBooleanImageHeight, getBooleanImageWidth, getBooleanPartialImage, getBooleanTrueImage, getCanAcceptDroppedRecords, getCanAddFormulaFields, getCanAddSummaryFields, getCanAutoFitFields, getCancelEditingConfirmationMessage, getCanCollapseGroup, getCanDragRecordsOut, getCanDragSelect, getCanDragSelectText, getCanDropInEmptyArea, getCanEdit, getCanEditFieldAttribute, getCanEditHilites, getCanEditTitles, getCanExpandMultipleRecords, getCanExpandRecordProperty, getCanExpandRecords, getCanFreezeFields, getCanGroupBy, getCanHover, getCanMultiGroup, getCanMultiSort, getCanPickFields, getCanPickOmittedFields, getCanRemoveRecords, getCanReorderFields, getCanReorderRecords, getCanResizeFields, getCanSelectAll, getCanSelectCells, getCanSort, getCanTabToHeader, getCellContextMenu, getCellCSSText, getCellErrors, getCellHoverComponent, getCellPadding, getCellPageRect, getCellRowSpan, getCellSelection, getCellStartRow, getCellStyle, getChartConstructor, getChartType, getCheckboxFieldFalseImage, getCheckboxFieldImageHeight, getCheckboxFieldImageWidth, getCheckboxFieldPartialImage, getCheckboxFieldTrueImage, getChildExpansionMode, getClearAllSortingText, getClearFilterText, getClearSortFieldText, getClipHeaderTitles, getColumnLeft, getColumnPageLeft, getColumnWidth, getConfigureGroupingText, getConfigureSortText, getConfirmCancelEditing, getConfirmDiscardEdits, getConfirmDiscardEditsMessage, getCriteria, getCurrentExpansionComponent, getCurrentExpansionComponent, getDataAsJSList, getDataAsRecordList, getDataFetchMode, getDataPageSize, getDateFormatter, getDatetimeFormatter, getDefaultFields, getDefaultFieldWidth, getDefaultFormattedFieldValue, getDefaultFormattedFieldValue, getDefaultFormattedFieldValue, getDefaultFormattedValue, getDeferRemoval, getDetailDS, getDetailField, getDiscardEditsOnHideField, getDiscardEditsSaveButtonTitle, getDisplayValue, getDisplayValue, getDisplayValue, getDisplayValue, getDisplayValue, getDragData, getDragDataAction, getDragTrackerMode, getDragTrackerStyle, getDrawAheadRatio, getDrawAllMaxCells, getDrawArea, getDrawnRowHeight, getDrawnRows, getDropCriteriaOnHideField, 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, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getEscapeKeyEditAction, getEventColumn, getEventColumn, getEventRow, getEventRow, getExpansionCanEdit, getExpansionComponent, getExpansionComponentPoolingMode, getExpansionDetailField, getExpansionDetailRelated, getExpansionDetails, getExpansionEditor, getExpansionEditorCollapseOnSave, getExpansionEditorSaveButton, getExpansionEditorSaveButtonTitle, getExpansionEditorSaveDialogPrompt, getExpansionEditorShowSaveDialog, getExpansionField, getExpansionFieldFalseImage, getExpansionFieldImageHeight, getExpansionFieldImageWidth, getExpansionFieldTrueImage, getExpansionLayout, getExpansionMode, getExpansionRelated, getExportAll, getExportAlternateRowBGColor, getExportBGColor, getExportColumnBGColor, getExportDefaultBGColor, getExportFieldAlignments, getExportFields, getExportFieldWidths, getExportHeaderHeights, getExportRawValues, getExportRowBGColor, getExportWidthScale, getExportWrapHeaderTitles, getFetchDelay, getFetchOperation, getField, getField, getFieldName, getFieldNum, getFieldNum, getFieldPickerFieldProperties, getFieldPickerShowSampleValues, getFieldPickerWindow, getFields, getFieldState, getFieldVisibilitySubmenuTitle, getFieldWidth, getFieldWidth, getFieldWidth, getFilterButtonPrompt, getFilterButtonProperties, getFilterByCell, getFilterEditor, getFilterEditorCriteria, getFilterEditorCriteria, getFilterEditorHeight, getFilterEditorProperties, getFilterLocalData, getFilterOnKeypress, getFixedFieldWidths, getFixedRecordHeights, getFocusRow, getFormulaBuilderSpanTitleSeparator, getFormulaFieldValue, getFreezeFieldText, getFreezeOnLeftText, getFreezeOnRightText, getFrozenBaseStyle, getFrozenHeaderBaseStyle, getFrozenHeaderTitleStyle, getGenerateClickOnEnter, getGenerateClickOnSpace, getGenerateDoubleClickOnEnter, getGenerateDoubleClickOnSpace, getGridComponents, getGridRenderer, getGridSummary, getGridSummaryData, getGridSummaryRecordProperty, getGroupByAsyncThreshold, getGroupByFields, getGroupByFieldSummaries, getGroupByMaxRecords, getGroupByText, getGroupIcon, getGroupIconSize, getGroupIndentSize, getGroupLeadingIndent, getGroupNodeBaseStyle, getGroupNodeStyle, getGroupState, getGroupSummaryRecordProperty, getGroupSummaryStyle, getGroupTitleColumnProperties, getGroupTitleField, getGroupTree, getHeader, getHeaderAutoFitEvent, getHeaderBackgroundColor, getHeaderBarStyle, getHeaderBaseStyle, getHeaderButtonProperties, getHeaderContextMenu, getHeaderContextMenuItems, getHeaderHeight, getHeaderHoverAlign, getHeaderHoverHeight, getHeaderHoverOpacity, getHeaderHoverStyle, getHeaderHoverVAlign, getHeaderHoverWidth, getHeaderHoverWrap, getHeaderMenuButton, getHeaderMenuButtonHeight, getHeaderMenuButtonIcon, getHeaderMenuButtonIconHeight, getHeaderMenuButtonIconWidth, getHeaderMenuButtonWidth, getHeaderSpan, getHeaderSpanContextMenuItems, getHeaderSpanHeight, getHeaderTitleStyle, getHiliteCanReplaceValue, getHiliteEditorSpanTitleSeparator, getHiliteHTMLAfterFormat, getHiliteIconHeight, getHiliteIconLeftPadding, getHiliteIconPosition, getHiliteIconRightPadding, getHiliteIcons, getHiliteIconSize, getHiliteIconWidth, getHiliteProperty, getHiliteReplaceValueFieldTitle, getHilites, getHiliteState, getHoverMode, getHoverStyle, getIconPadding, getImageSize, getIncludeHilitesInSummaryFields, getIncludeInSummaryProperty, getInitialCriteria, getInitialSort, getInstantScrollTrackRedraw, getInvalidSummaryValue, getIsGrouped, getIsSeparatorProperty, getLeaveScrollbarGap, getLinkTextProperty, getListEndEditAction, getLoadingDataMessage, getLoadingDataMessageStyle, getLoadingMessage, getLocateColumnsBy, getLocateRowsBy, getLongTextEditorThreshold, getLongTextEditorType, getMaxExpandedRecords, getMaxExpandedRecordsPrompt, getMinFieldWidth, getMissingSummaryFieldValue, getModalEditing, getNavigateOnTab, getNeverValidate, getNormalBaseStyle, getNormalCellHeight, getNullGroupTitle, getOfflineMessageStyle, getOriginalRecordList, getOriginalResultSet, getOriginBaseStyle, getPoolComponentsPerColumn, getPreventDuplicates, getPrintAutoFit, getPrintBaseStyle, getPrintHeaderStyle, getPrintMaxRows, getPrintWrapCells, getProgressiveLoading, getQuickDrawAheadRatio, getRecord, getRecordBaseStyleProperty, getRecordCanRemoveProperty, getRecordCanSelectProperty, getRecordComponent, getRecordComponent, getRecordComponentHeight, getRecordComponentPoolingMode, getRecordComponentPosition, getRecordDetailDSProperty, getRecordDropAppearance, getRecordDropPosition, getRecordEditProperty, getRecordEnabledProperty, getRecordIndex, getRecordIndex, getRecordList, getRecords, getRecordSummaryBaseStyle, getRelatedDataSource, getRemovedCSSText, getRemoveFieldDefaults, getRemoveFieldProperties, getRemoveFieldTitle, getRemoveIcon, getRemoveIconSize, getRemoveOperation, getReselectOnUpdate, getReselectOnUpdateNotifications, getResizeFieldsInRealTime, getResultSet, getReverseRTLAlign, getRollOverCanvas, getRollUnderCanvas, getRowEndEditAction, getRowErrors, getRowHeight, getRowNumberField, getRowNumberStart, getRowNumberStyle, getRowPageTop, getRowSpan, getRowSpanEditMode, getRowSpanSelectionMode, getRowTop, getSaveByCell, getSaveLocally, getSaveRequestProperties, getScreenReaderCellSeparator, getScreenReaderRowSeparator, getScrollRedrawDelay, getScrollToCellXPosition, getScrollToCellYPosition, getScrollWheelRedrawDelay, getSelectedCellData, getSelectedRecord, getSelectedRecords, getSelectedRecords, getSelectedState, getSelectHeaderOnSort, getSelection, getSelection, getSelectionAppearance, getSelectionProperty, getSelectionType, getSelectOnEdit, getShowAllColumns, getShowAllRecords, getShowAsynchGroupingPrompt, getShowBackgroundComponents, getShowCellContextMenus, getShowClippedHeaderTitlesOnHover, getShowClippedValuesOnHover, getShowCollapsedGroupSummary, getShowComplexFields, getShowDetailFields, getShowEmptyMessage, getShowErrorIcons, getShowExpansionEditorSaveButton, getShowFilterEditor, getShowGridSummary, getShowGroupSummary, getShowGroupSummaryInHeader, getShowGroupTitleColumn, getShowHeader, getShowHeaderContextMenu, getShowHeaderMenuButton, getShowHeaderSpanTitlesInFormulaBuilder, getShowHeaderSpanTitlesInHiliteEditor, getShowHeaderSpanTitlesInSortEditor, getShowHiddenFields, getShowHilitesInGroupSummary, getShowHover, getShowHoverComponents, getShowRecordComponents, getShowRecordComponentsByCell, getShowRollOver, getShowRollOverCanvas, getShowRowNumbers, getShowSelectedStyle, getShowSelectionCanvas, getShowSortArrow, getShowSortNumerals, getShowTreeColumnPicker, getShrinkForFreeze, getSingleCellValueProperty, getSkinImgDir, getSort, getSortAscendingImage, getSortDescendingImage, getSortDirection, getSortEditorSpanTitleSeparator, getSorterButtonTitle, getSortField, getSortFieldAscendingText, getSortFieldCount, getSortFieldDescendingText, getSortNumeralHTML, getSortNumeralStyle, getSortSpecifier, getSortState, getSpanContextMenu, getStopOnErrors, getStyleName, getSummaryFieldValue, getSummaryRow, getSummaryRowCriteria, getSummaryRowDataSource, getSummaryRowFetchRequestProperties, getSummaryRowHeight, getSummaryRowStyle, getTallBaseStyle, getTitleField, getTitleFieldValue, getToggleFreezeText, getTotalRows, getTrackerImage, getUnfreezeFieldText, getUngroupText, getUnremoveIcon, getUpdateOperation, getUseAdvancedFieldPicker, getUseAllDataSourceFields, getUseCellRollOvers, getUseCopyPasteShortcuts, getUseFlatFields, getUseRemoteValidators, getUseRowSpanStyling, getValidateByCell, getValidateOnChange, getValueIcon, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getViewState, getVirtualScrolling, getVisibleRows, getWaitForSave, getWarnOnRemoval, getWarnOnRemovalMessage, getWarnOnUnmappedValueFieldChange, getWrapCells, getWrapHeaderTitles, groupBy, hasChanges, hasErrors, headerHoverHTML, headerTitleClipped, hideField, hideField, hideFields, hideFields, hideFields, hideFields, invalidateCache, invalidateRecordComponents, isCheckboxField, isExpanded, isExpansionField, isGrouped, isGroupNode, isPartiallySelected, isRowNumberField, isSelected, isSortField, markForRedraw, markForRedraw, markRecordRemoved, markRecordsRemoved, markRecordsRemoved, markSelectionRemoved, onInit, openRecordDetailGrid, openRecordEditor, preloadImages, recalculateGridSummary, recalculateSummaries, recalculateSummaries, recalculateSummaries, recordClick, recordMarkedAsRemoved, refreshCell, refreshCell, refreshCellStyle, refreshFields, refreshRecordComponent, refreshRecordComponent, refreshRow, removeData, removeData, removeData, removeEmbeddedComponent, removeEmbeddedComponent, removeEmbeddedComponent, removeRecordClick, removeSelectedData, removeSelectedData, removeSelectedData, reorderField, reorderFields, resizeField, resort, rowClick, rowClick, rowDoubleClick, rowDoubleClick, rowHasChanges, rowHasErrors, saveAllEdits, saveAllEdits, saveAllEdits, saveEdits, saveEdits, saveEdits, saveEdits, scrollBodyTo, scrollToCell, scrollToCell, scrollToCell, scrollToColumn, scrollToColumn, scrollToRow, scrollToRow, selectAllRecords, selectRange, selectRange, selectRecord, selectRecord, selectRecord, selectRecord, selectRecords, selectRecords, selectRecords, selectRecords, selectSingleRecord, selectSingleRecord, setAddDropValues, setAddFormulaFieldText, setAddOperation, setAddSummaryFieldText, setAdvancedFieldPickerThreshold, setAllowFilterExpressions, setAllowRowSpanning, setAlternateBodyStyleName, setAlternateFieldFrequency, setAlternateFieldStyles, setAlternateRecordFrequency, setAlwaysShowEditors, setAnimateFolderEffect, setAnimateFolderMaxRows, setAnimateFolders, setAnimateFolderSpeed, setAnimateFolderTime, setAnimateRemoveRecord, setAnimateRemoveSpeed, setAnimateRemoveTime, setAnimateRollOver, setAnimateRollUnder, setAnimateSelection, setAnimateSelectionUnder, setApplyFormulaAfterSummary, setApplyRowNumberStyle, setArrowKeyAction, setAsynchGroupingPrompt, setAutoFetchAsFilter, setAutoFetchData, setAutoFetchDisplayMap, setAutoFetchTextMatchStyle, setAutoFitAllText, setAutoFitClipFields, setAutoFitData, setAutoFitExpandField, setAutoFitExtraRecords, setAutoFitFieldsFillViewport, setAutoFitFieldText, setAutoFitFieldWidths, setAutoFitHeaderHeights, setAutoFitIconFields, setAutoFitMaxColumns, setAutoFitMaxHeight, setAutoFitMaxRecords, setAutoFitMaxWidth, setAutoFitWidth, setAutoFitWidthApproach, setAutoSaveEdits, setAutoSizeHeaderSpans, setBadFormulaResultValue, setBodyBackgroundColor, setBodyOverflow, setBooleanBaseStyle, setBooleanFalseImage, setBooleanImageHeight, setBooleanImageWidth, setBooleanPartialImage, setBooleanTrueImage, setCanAcceptDroppedRecords, setCanAddFormulaFields, setCanAddSummaryFields, setCanAutoFitFields, setCancelEditingConfirmationMessage, setCanCollapseGroup, setCanDragRecordsOut, setCanDragSelect, setCanDragSelectText, setCanDropInEmptyArea, setCanEdit, setCanEditFieldAttribute, setCanEditHilites, setCanEditTitles, setCanExpandMultipleRecords, setCanExpandRecordProperty, setCanExpandRecords, setCanFreezeFields, setCanGroupBy, setCanHover, setCanMultiGroup, setCanMultiSort, setCanPickFields, setCanPickOmittedFields, setCanRemoveRecords, setCanReorderFields, setCanReorderRecords, setCanResizeFields, setCanSelectAll, setCanSelectCells, setCanSort, setCanTabToHeader, setCellFormatter, setCellPadding, setCellValueHoverFormatter, setChartConstructor, setChartType, setCheckboxFieldFalseImage, setCheckboxFieldImageHeight, setCheckboxFieldImageWidth, setCheckboxFieldPartialImage, setCheckboxFieldProperties, setCheckboxFieldTrueImage, setChildExpansionMode, setClearAllSortingText, setClearFilterText, setClearSortFieldText, setClipHeaderTitles, setConfigureGroupingText, setConfigureSortText, setConfirmCancelEditing, setConfirmDiscardEdits, setConfirmDiscardEditsMessage, setCriteria, setData, setDataFetchMode, setDataPageSize, setDataProperties, setDataSource, setDateFormatter, setDateInputFormat, setDatetimeFormatter, setDefaultFields, setDefaultProperties, setDeferRemoval, setDetailDS, setDetailDS, setDetailField, setDiscardEditsOnHideField, setDiscardEditsSaveButtonTitle, setDontAutoDestroyComponent, setDragDataAction, setDragTrackerIconCustomizer, setDragTrackerMode, setDragTrackerStyle, setDragTrackerTitleCustomizer, setDrawAheadRatio, setDrawAllMaxCells, setDropCriteriaOnHideField, setDropValues, setDuplicateDragMessage, setEditByCell, setEditEvent, setEditFailedBaseStyle, setEditFailedCSSText, setEditFormulaFieldText, setEditOnF2Keypress, setEditOnFocus, setEditorCustomizer, setEditorValueMap, setEditorValueMap, setEditPendingBaseStyle, setEditPendingCSSText, setEditSummaryFieldText, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValues, setEmptyCellValue, setEmptyMessageStyle, setEnforceVClipping, setEnterKeyEditAction, setEnumCriteriaAsInitialValues, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setEscapeKeyEditAction, setExpansionCanEdit, setExpansionComponentPoolingMode, setExpansionEditorSaveDialogPrompt, setExpansionEditorShowSaveDialog, setExpansionFieldFalseImage, setExpansionFieldImageHeight, setExpansionFieldImageWidth, setExpansionFieldTrueImage, setExpansionMode, setExportAll, setExportAlternateRowBGColor, setExportDefaultBGColor, setExportFieldAlignments, setExportFields, setExportFieldWidths, setExportHeaderHeights, setExportRawValues, setExportWidthScale, setExportWrapHeaderTitles, setFastCellUpdates, setFetchDelay, setFetchOperation, setFieldButtonProperties, setFieldCellIcon, setFieldError, setFieldError, setFieldHeaderBaseStyle, setFieldHeaderTitleStyle, setFieldIcon, setFieldPickerFieldProperties, setFieldPickerShowSampleValues, setFields, setFieldState, setFieldTitle, setFieldTitle, setFieldVisibilitySubmenuTitle, setFilterButtonPrompt, setFilterButtonProperties, setFilterByCell, setFilterEditorCriteria, setFilterEditorHeight, setFilterEditorProperties, setFilterEditorProperties, setFilterLocalData, setFilterOnKeypress, setFixedFieldWidths, setFixedRecordHeights, setFormulaBuilderSpanTitleSeparator, setFreezeFieldText, setFreezeOnLeftText, setFreezeOnRightText, setFrozenBaseStyle, setFrozenHeaderBaseStyle, setFrozenHeaderTitleStyle, setGenerateClickOnEnter, setGenerateClickOnSpace, setGenerateDoubleClickOnEnter, setGenerateDoubleClickOnSpace, setGridComponents, setGridComponents, setGridSummaryRecordProperty, setGroupByAsyncThreshold, setGroupByField, setGroupByField, setGroupByFieldSummaries, setGroupByMaxRecords, setGroupByText, setGroupIcon, setGroupIconSize, setGroupIndentSize, setGroupLeadingIndent, setGroupNodeBaseStyle, setGroupNodeStyle, setGroupStartOpen, setGroupStartOpen, setGroupState, setGroupSummaryRecordProperty, setGroupSummaryStyle, setGroupTitleColumnProperties, setGroupTitleField, setHeaderAutoFitEvent, setHeaderBackgroundColor, setHeaderBarStyle, setHeaderBaseStyle, setHeaderButtonProperties, setHeaderHeight, setHeaderHoverAlign, setHeaderHoverFormatter, setHeaderHoverHeight, setHeaderHoverOpacity, setHeaderHoverStyle, setHeaderHoverVAlign, setHeaderHoverWidth, setHeaderHoverWrap, setHeaderMenuButtonHeight, setHeaderMenuButtonIcon, setHeaderMenuButtonIconHeight, setHeaderMenuButtonIconWidth, setHeaderMenuButtonWidth, setHeaderSpanBaseStyle, setHeaderSpanButtonProperties, setHeaderSpanHeaderTitle, setHeaderSpanHeight, setHeaderSpans, setHeaderSpanTitle, setHeaderSpanTitleStyle, setHeaderTitleStyle, setHiliteCanReplaceValue, setHiliteEditorSpanTitleSeparator, setHiliteHTMLAfterFormat, setHiliteIconHeight, setHiliteIconLeftPadding, setHiliteIconPosition, setHiliteIconRightPadding, setHiliteIcons, setHiliteIconSize, setHiliteIconWidth, setHiliteProperty, setHiliteReplaceValueFieldTitle, setHilites, setHiliteState, setHoverCustomizer, setHoverMode, setHoverStyle, setIconPadding, setImageSize, setIncludeHilitesInSummaryFields, setIncludeInSummaryProperty, setInitialCriteria, setInitialSort, setInstantScrollTrackRedraw, setInvalidSummaryValue, setIsSeparatorProperty, setLeaveHeaderMenuButtonSpace, setLeaveScrollbarGap, setLinkTextProperty, setListEndEditAction, setLoadingDataMessage, setLoadingDataMessageStyle, setLoadingMessage, setLocateColumnsBy, setLocateRowsBy, setLogicalStructure, setLongTextEditorThreshold, setLongTextEditorType, setMaxExpandedRecords, setMaxExpandedRecordsPrompt, setMinFieldWidth, setMissingSummaryFieldValue, setModalEditing, setNavigateOnTab, setNeverValidate, setNormalBaseStyle, setNormalCellHeight, setNullGroupTitle, setOfflineMessageStyle, setOriginBaseStyle, setPoolComponentsPerColumn, setPreventDuplicates, setPrintAutoFit, setPrintBaseStyle, setPrintHeaderStyle, setPrintMaxRows, setPrintWrapCells, setProgressiveLoading, setQuickDrawAheadRatio, setRecordBaseStyleProperty, setRecordCanRemoveProperty, setRecordCanSelectProperty, setRecordComponentHeight, setRecordComponentPoolingMode, setRecordComponentPosition, setRecordDetailDSProperty, setRecordDropAppearance, setRecordEditProperty, setRecordEnabledProperty, setRecords, setRecordSummaryBaseStyle, setRemovedCSSText, setRemoveFieldProperties, setRemoveFieldTitle, setRemoveIcon, setRemoveIconSize, setRemoveOperation, setReselectOnUpdate, setReselectOnUpdateNotifications, setResizeFieldsInRealTime, setReverseRTLAlign, setRollUnderCanvasProperties, setRowEndEditAction, setRowErrors, setRowErrors, setRowNumberFieldProperties, setRowNumberStart, setRowNumberStyle, setRowSpanEditMode, setRowSpanSelectionMode, setSaveByCell, setSaveLocally, setSaveRequestProperties, setScreenReaderCellSeparator, setScreenReaderRowSeparator, setScrollRedrawDelay, setScrollToCellXPosition, setScrollToCellYPosition, setScrollWheelRedrawDelay, setSelectedState, setSelectHeaderOnSort, setSelectionAppearance, setSelectionCanvasProperties, setSelectionProperty, setSelectionType, setSelectionUnderCanvasProperties, setSelectOnEdit, setShowAllColumns, setShowAllRecords, setShowAsynchGroupingPrompt, setShowBackgroundComponents, setShowCellContextMenus, setShowClippedHeaderTitlesOnHover, setShowClippedValuesOnHover, setShowCollapsedGroupSummary, setShowComplexFields, setShowDetailFields, setShowEmptyMessage, setShowErrorIcons, setShowFilterEditor, setShowGridSummary, setShowGroupSummary, setShowGroupSummaryInHeader, setShowGroupTitleColumn, setShowHeader, setShowHeaderContextMenu, setShowHeaderMenuButton, setShowHeaderSpanTitlesInFormulaBuilder, setShowHeaderSpanTitlesInHiliteEditor, setShowHeaderSpanTitlesInSortEditor, setShowHiddenFields, setShowHilitesInGroupSummary, setShowHover, setShowHoverComponents, setShowRecordComponents, setShowRecordComponentsByCell, setShowRollOver, setShowRollOverCanvas, setShowRowNumbers, setShowSelectedStyle, setShowSelectionCanvas, setShowSortArrow, setShowSortNumerals, setShowTreeColumnPicker, setShrinkForFreeze, setSingleCellValueProperty, setSkinImgDir, setSort, setSortAscendingImage, setSortDescendingImage, setSortDirection, setSortEditorSpanTitleSeparator, setSorterButtonTitle, setSortField, setSortField, setSortField, setSortFieldAscendingText, setSortFieldDescendingText, setSortNumeralStyle, setSortState, setStopOnErrors, setStyleName, setSummaryRowCriteria, setSummaryRowDataSource, setSummaryRowFetchRequestProperties, setSummaryRowHeight, setSummaryRowStyle, setTallBaseStyle, setTitleField, setTrackerImage, setUnfreezeFieldText, setUngroupText, setUnremoveIcon, setUpdateOperation, setUseAdvancedFieldPicker, setUseAllDataSourceFields, setUseCellRollOvers, setUseCopyPasteShortcuts, setUseFlatFields, setUseRemoteValidators, setUseRowSpanStyling, setValidateByCell, setValidateOnChange, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setViewState, setVirtualScrolling, setWaitForSave, setWarnOnRemoval, setWarnOnRemovalMessage, setWarnOnUnmappedValueFieldChange, setWrapCells, setWrapHeaderTitles, shouldIncludeHiliteInSummaryField, showField, showField, showFields, showFields, showFields, showFields, showRecordComponent, sort, sort, sort, sort, startEditing, startEditing, startEditing, startEditing, startEditingNew, startEditingNew, startEditingNew, startEditingNew, stopHover, summaryUpdated, toggleSort, transferSelectedData, transferSelectedData, unfreezeField, unfreezeField, unfreezeField, unfreezeField, unfreezeFields, unfreezeFields, ungroup, unmarkRecordRemoved, unsort, updateData, updateData, updateData, updateRecordComponent, userSelectAllRecords, validateCell, validateCell, validateRow, willAcceptDrop, willFetchData, willFetchData
 
Methods inherited from class com.smartgwt.client.widgets.layout.VLayout
setDefaultProperties, setLogicalStructure
 
Methods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersMargin, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMember
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, 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, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, 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, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, focus, focusInNextTabElement, focusInPreviousTabElement, 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, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getElement, getElement, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowResizeBar, getShowShadow, getShrinkElementOnHide, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setElement, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowResizeBar, setShowShadow, setShrinkElementOnHide, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, 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, setConfigOnly, setDragTracker, setID, setJavaScriptObject, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, 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
 

Field Detail

ICON_FIELD

public static final ListGridField ICON_FIELD

TITLE_FIELD

public static final ListGridField TITLE_FIELD

KEY_FIELD

public static final ListGridField KEY_FIELD

SUBMENU_FIELD

public static final ListGridField SUBMENU_FIELD
Constructor Detail

Menu

public Menu()

Menu

public Menu(JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static Menu getOrCreateRef(JavaScriptObject jsObj)

getTestInstance

protected Menu getTestInstance()
Overrides:
getTestInstance in class ListGrid

changeAutoChildDefaults

public static void changeAutoChildDefaults(String autoChildName,
                                           Canvas defaults)
Changes the defaults for Canvas AutoChildren named autoChildName.

Parameters:
autoChildName - name of an AutoChild to customize the defaults for.
defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties.
See Also:
AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(String autoChildName,
                                           FormItem defaults)
Changes the defaults for FormItem AutoChildren named autoChildName.

Parameters:
autoChildName - name of an AutoChild to customize the defaults for.
defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties.
See Also:
AutoChildUsage

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 - 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 - 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 - 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 - 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 - See CSSStyleName . 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:
See CSSStyleName
See Also:
Appearance overview and related methods

setBodyStyleName

public void setBodyStyleName(String bodyStyleName)
CSS style used for the body of this menu when there is no icon field. When there is an icon field, then iconBodyStyleName, if set, will override this setting.

If applying a background-color to the body via a CSS style applied using this property, be sure to set bodyBackgroundColor to null.

Overrides:
setBodyStyleName in class ListGrid
Parameters:
bodyStyleName - See CSSStyleName . Default value is "normal"
See Also:
Appearance overview and related methods

getBodyStyleName

public String getBodyStyleName()
CSS style used for the body of this menu when there is no icon field. When there is an icon field, then iconBodyStyleName, if set, will override this setting.

If applying a background-color to the body via a CSS style applied using this property, be sure to set bodyBackgroundColor to null.

Overrides:
getBodyStyleName in class ListGrid
Returns:
See CSSStyleName
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 - 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 - 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 - 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

setCheckmarkDisabledImage

public void setCheckmarkDisabledImage(Img checkmarkDisabledImage)
                               throws IllegalStateException
Default image to display for disabled checkmarked items. See ImgProperties for format. Valid src, width and height must be specified.

Parameters:
checkmarkDisabledImage - Default value is {...}
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getCheckmarkDisabledImage

public Img getCheckmarkDisabledImage()
Default image to display for disabled checkmarked items. See ImgProperties for format. Valid src, width and height must be specified.

Returns:
Img

setCheckmarkImage

public void setCheckmarkImage(Img checkmarkImage)
                       throws IllegalStateException
Default image to display for checkmarked items. See ImgProperties for format. Valid src, width and height must be specified.

Parameters:
checkmarkImage - Default value is {...}
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getCheckmarkImage

public Img getCheckmarkImage()
Default image to display for checkmarked items. See ImgProperties for format. Valid src, width and height must be specified.

Returns:
Img

setData

public void setData(MenuItem... data)
An array of menuItem objects, specifying the menu items this menu should show. Data may also be set to a Tree in which case a hierarchy of menus and submenus will automatically be generated to match the tree structure. See also dataSource for dynamically fetching menuItems and submenus from a hierachical DataSource.

If this method is called after the component has been drawn/initialized: Change the set of items to display in this menu

Parameters:
data - new items for this menu. Default value is null
See Also:
Appearance Example

setData

public void setData(Record[] data)
An array of menuItem objects, specifying the menu items this menu should show. Data may also be set to a Tree in which case a hierarchy of menus and submenus will automatically be generated to match the tree structure. See also dataSource for dynamically fetching menuItems and submenus from a hierachical DataSource.

If this method is called after the component has been drawn/initialized: Change the set of items to display in this menu

Overrides:
setData in class ListGrid
Parameters:
data - new items for this menu. Default value is null
See Also:
Appearance Example

setData

public void setData(Tree data)
An array of menuItem objects, specifying the menu items this menu should show. Data may also be set to a Tree in which case a hierarchy of menus and submenus will automatically be generated to match the tree structure. See also dataSource for dynamically fetching menuItems and submenus from a hierachical DataSource.

If this method is called after the component has been drawn/initialized: Change the set of items to display in this menu

Parameters:
data - new items for this menu. Default value is null
See Also:
Appearance Example

setData

public void setData(RecordList data)
An array of menuItem objects, specifying the menu items this menu should show. Data may also be set to a Tree in which case a hierarchy of menus and submenus will automatically be generated to match the tree structure. See also dataSource for dynamically fetching menuItems and submenus from a hierachical DataSource.

If this method is called after the component has been drawn/initialized: Change the set of items to display in this menu

Overrides:
setData in class ListGrid
Parameters:
data - new items for this menu. Default value is null
See Also:
Appearance Example

setDataSource

public void setDataSource(DataSource dataSource)
                   throws IllegalStateException
Optional DataSource to fetch menuItems and submenus from, instead of using items.

The provided DataSource must be set up for hierarchical fetching - see the Tree Data Binding overview.

Specified by:
setDataSource in interface DataBoundComponent
Overrides:
setDataSource in class ListGrid
Parameters:
dataSource - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getDataSource

public DataSource getDataSource()
Optional DataSource to fetch menuItems and submenus from, instead of using items.

The provided DataSource must be set up for hierarchical fetching - see the Tree Data Binding overview.

Specified by:
getDataSource in interface DataBoundComponent
Overrides:
getDataSource in class ListGrid
Returns:
DataSource

setDefaultWidth

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

Overrides:
setDefaultWidth in class Canvas
Parameters:
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 - See HTMLString . Default value is "[Empty menu]"
See Also:
Empty grid Example

getEmptyMessage

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

Overrides:
getEmptyMessage in class ListGrid
Returns:
See HTMLString
See Also:
Empty grid Example

setFetchSubmenus

public void setFetchSubmenus(Boolean fetchSubmenus)
                      throws IllegalStateException
When using a Tree or hierarchical DataSource as the menu's data, submenus are automatically generated from child nodes. fetchSubmenus can be set to false to disable this for the whole menu, or can be set false on a per-item basis via fetchSubmenus.

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

getFetchSubmenus

public Boolean getFetchSubmenus()
When using a Tree or hierarchical DataSource as the menu's data, submenus are automatically generated from child nodes. fetchSubmenus can be set to false to disable this for the whole menu, or can be set false on a per-item basis via fetchSubmenus.

Returns:
Boolean

setIconBodyStyleName

public void setIconBodyStyleName(String iconBodyStyleName)
                          throws IllegalStateException
If set, the CSS style used for the body of this menu when there is an icon field. In RTL mode, the iconBodyStyleName is suffixed with "RTL", which allows skins to apply different styles in LTR and RTL modes.

Note: Any skin which uses iconBodyStyleName should add "RTL" styles as well, even if identical to LTR styles. Otherwise, menus may lose their styling in RTL mode.

Parameters:
iconBodyStyleName - See CSSStyleName . Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
Appearance overview and related methods

getIconBodyStyleName

public String getIconBodyStyleName()
If set, the CSS style used for the body of this menu when there is an icon field. In RTL mode, the iconBodyStyleName is suffixed with "RTL", which allows skins to apply different styles in LTR and RTL modes.

Note: Any skin which uses iconBodyStyleName should add "RTL" styles as well, even if identical to LTR styles. Otherwise, menus may lose their styling in RTL mode.

Returns:
See CSSStyleName
See Also:
Appearance overview and related methods

setIconFieldDefaults

public void setIconFieldDefaults(ListGridField iconFieldDefaults)
                          throws IllegalStateException
Default properties for the automatically generated icon column. Default object includes properties to set width and to show icon for this column.

To modify the behavior or appearance of this column, developers may set iconFieldProperties at the instance level, or override this object at the class level. If overriding this object, we recommend using Class.changeDefaults rather than replacing this object entirely.

See showIcons for an overview of the icon column.

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

getIconFieldDefaults

public ListGridField getIconFieldDefaults()
Default properties for the automatically generated icon column. Default object includes properties to set width and to show icon for this column.

To modify the behavior or appearance of this column, developers may set iconFieldProperties at the instance level, or override this object at the class level. If overriding this object, we recommend using Class.changeDefaults rather than replacing this object entirely.

See showIcons for an overview of the icon column.

Returns:
ListGridField

setIconFieldProperties

public void setIconFieldProperties(ListGridField iconFieldProperties)
                            throws IllegalStateException
Custom properties for the automatically generated icon column.

See showIcons for an overview of the icon column.

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

getIconFieldProperties

public ListGridField getIconFieldProperties()
Custom properties for the automatically generated icon column.

See showIcons for an overview of the icon column.

Returns:
ListGridField

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 - 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 - 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

setItems

public void setItems(MenuItem... items)
Synonym for data

If this method is called after the component has been drawn/initialized: Synonym for Menu.setData.

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

setKeyFieldDefaults

public void setKeyFieldDefaults(ListGridField keyFieldDefaults)
                         throws IllegalStateException
Default properties for the automatically generated icon column. Default object includes properties to set width and to show key for this column.

To modify the behavior or appearance of this column, developers may set keyFieldProperties at the instance level, or override this object at the class level. If overriding this object, we recommend using Class.changeDefaults rather than replacing this object entirely.

See showKeys for an overview of the key column.

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

getKeyFieldDefaults

public ListGridField getKeyFieldDefaults()
Default properties for the automatically generated icon column. Default object includes properties to set width and to show key for this column.

To modify the behavior or appearance of this column, developers may set keyFieldProperties at the instance level, or override this object at the class level. If overriding this object, we recommend using Class.changeDefaults rather than replacing this object entirely.

See showKeys for an overview of the key column.

Returns:
ListGridField

setKeyFieldProperties

public void setKeyFieldProperties(ListGridField keyFieldProperties)
                           throws IllegalStateException
Custom properties for the automatically generated key column.

See showKeys for an overview of the key column.

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

getKeyFieldProperties

public ListGridField getKeyFieldProperties()
Custom properties for the automatically generated key column.

See showKeys for an overview of the key column.

Returns:
ListGridField

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 - 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 - 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 - 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 - 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 - 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

setSubmenuConstructor

public void setSubmenuConstructor(String submenuConstructor)
                           throws IllegalStateException
When using a Tree or hierarchical DataSource as the menu's data, optional subclass of Menu that should be used when generating submenus.

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

getSubmenuConstructor

public String getSubmenuConstructor()
When using a Tree or hierarchical DataSource as the menu's data, optional subclass of Menu that should be used when generating submenus.

Returns:
See SCClassName

setSubmenuDirection

public void setSubmenuDirection(String submenuDirection)
Should submenus show up on our left or right. Can validly be set to "left" or "right". If unset, submenus show up on the right by default in Left-to-right text mode, or on the left in Right-to-left text mode (see Page.isRTL).

Parameters:
submenuDirection - Default value is null

getSubmenuDirection

public String getSubmenuDirection()
Should submenus show up on our left or right. Can validly be set to "left" or "right". If unset, submenus show up on the right by default in Left-to-right text mode, or on the left in Right-to-left text mode (see Page.isRTL).

Returns:
String

setSubmenuDisabledImage

public void setSubmenuDisabledImage(Img submenuDisabledImage)
                             throws IllegalStateException
Default image to use for the submenu indicator when item is disabled. Valid src, width and height must be specified. See ImgProperties for format.
If submenuDirection is set to "left", the image src will have the suffix "_left" appended to it.

Parameters:
submenuDisabledImage - Default value is {...}
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getSubmenuDisabledImage

public Img getSubmenuDisabledImage()
Default image to use for the submenu indicator when item is disabled. Valid src, width and height must be specified. See ImgProperties for format.
If submenuDirection is set to "left", the image src will have the suffix "_left" appended to it.

Returns:
Img

setSubmenuFieldDefaults

public void setSubmenuFieldDefaults(ListGridField submenuFieldDefaults)
                             throws IllegalStateException
Default properties for the automatically generated submenu column. Default object includes properties to set width, align and to show submenu icon for this column.

To modify the behavior or appearance of this column, developers may set submenuFieldProperties at the instance level, or override this object at the class level. If overriding this object, we recommend using Class.changeDefaults rather than replacing this object entirely.

See showSubmenus for an overview of the submenu column.

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

getSubmenuFieldDefaults

public ListGridField getSubmenuFieldDefaults()
Default properties for the automatically generated submenu column. Default object includes properties to set width, align and to show submenu icon for this column.

To modify the behavior or appearance of this column, developers may set submenuFieldProperties at the instance level, or override this object at the class level. If overriding this object, we recommend using Class.changeDefaults rather than replacing this object entirely.

See showSubmenus for an overview of the submenu column.

Returns:
ListGridField

setSubmenuFieldProperties

public void setSubmenuFieldProperties(ListGridField submenuFieldProperties)
                               throws IllegalStateException
Custom properties for the automatically generated submenu column.

See showSubmenus for an overview of the submenu column.

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

getSubmenuFieldProperties

public ListGridField getSubmenuFieldProperties()
Custom properties for the automatically generated submenu column.

See showSubmenus for an overview of the submenu column.

Returns:
ListGridField

setSubmenuImage

public void setSubmenuImage(Img submenuImage)
                     throws IllegalStateException
Default image to use for the submenu indicator. Valid src, width and height must be specified. See ImgProperties for format.
If submenuDirection is set to "left", the image src will have the suffix "_left" appended to it.

Parameters:
submenuImage - Default value is {...}
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getSubmenuImage

public Img getSubmenuImage()
Default image to use for the submenu indicator. Valid src, width and height must be specified. See ImgProperties for format.
If submenuDirection is set to "left", the image src will have the suffix "_left" appended to it.

Returns:
Img

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 - 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

setTitleFieldDefaults

public void setTitleFieldDefaults(ListGridField titleFieldDefaults)
                           throws IllegalStateException
Default properties for the automatically generated title column. Default object includes properties to set width and to show title for this column.

To modify the behavior or appearance of this column, developers may set titleFieldProperties at the instance level, or override this object at the class level. If overriding this object, we recommend using Class.changeDefaults rather than replacing this object entirely.

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

getTitleFieldDefaults

public ListGridField getTitleFieldDefaults()
Default properties for the automatically generated title column. Default object includes properties to set width and to show title for this column.

To modify the behavior or appearance of this column, developers may set titleFieldProperties at the instance level, or override this object at the class level. If overriding this object, we recommend using Class.changeDefaults rather than replacing this object entirely.

Returns:
ListGridField

setTitleFieldProperties

public void setTitleFieldProperties(ListGridField titleFieldProperties)
                             throws IllegalStateException
Custom properties for the automatically generated title column.

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

getTitleFieldProperties

public ListGridField getTitleFieldProperties()
Custom properties for the automatically generated title column.

Returns:
ListGridField

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 - 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
See Also:
Visibility overview and related methods

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 existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

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

Parameters:
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

getSubmenu

public Menu getSubmenu(MenuItem item)
Creates and returns the submenu associated with the provided MenuItem.

Parameters:
menuItem - to target
Returns:
submenu for that menuItem
See Also:
Appearance Example

setDataProperties

public void setDataProperties(Tree dataProperties)
                       throws IllegalStateException
For a Menu that uses a DataSource, these properties will be passed to the automatically-created ResultTree. This can be used for various customizations such as modifying the automatically-chosen parentIdField.

Parameters:
dataProperties - dataProperties Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
Databinding overview and related methods

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

getOrCreateRef

public static Menu getOrCreateRef(JavaScriptObject jsObj,
                                  MenuItem parentItem)

relinkJavaScriptObject

public void relinkJavaScriptObject(JavaScriptObject jsObj)

getOrCreateJsObj

public JavaScriptObject getOrCreateJsObj()
Specified by:
getOrCreateJsObj in interface DataBoundComponent
Overrides:
getOrCreateJsObj in class BaseWidget

setConfig

public void setConfig(JavaScriptObject config)
Overrides:
setConfig in class BaseWidget

setLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.menu.MenuLogicalStructure s)

getLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
Specified by:
getLogicalStructure in interface LogicalStructure
Overrides:
getLogicalStructure in class ListGrid