com.smartgwt.client.widgets

## Class MultiGroupDialog

- java.lang.Object
- - com.google.gwt.user.client.ui.UIObject
  - - com.google.gwt.user.client.ui.Widget
    - - com.smartgwt.client.widgets.BaseWidget
      - - com.smartgwt.client.widgets.Canvas
        - - com.smartgwt.client.widgets.layout.Layout
          - - com.smartgwt.client.widgets.layout.VLayout
            - - com.smartgwt.client.widgets.Window
              - - com.smartgwt.client.widgets.MultiGroupDialog

- All Implemented Interfaces:
    com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, LogicalStructure, HasClickHandlers, HasCloseClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMaximizeClickHandlers, HasMinimizeClickHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRestoreClickHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers

      public class MultiGroupDialog
      extends Window

  A dialog that allows the user to set up complex grouping arrangements by defining a group of GroupSpecifiers.

  Each GroupSpecifier applies to a single property and grouping - so, for instance, in a grid with two columns, `Nationhood` and `Country`, you could group first by `Nationhood` with its selected groupingMode and then by `Country` with its selected groupingMode.

  Important Note: this class should not be used directly - it is exposed purely for `i18n reasons.`

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

      `com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled`

  - ### Field Summary

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

      `config, configOnly, id, isElementSet, nativeObject, scClassName`

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

      `DEBUG_ID_PREFIX`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `MultiGroupDialog()`
    `MultiGroupDialog(com.google.gwt.core.client.JavaScriptObject jsObj)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static void` | `changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)` Changes the defaults for Canvas AutoChildren named `autoChildName`.
    `static void` | `changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)` Changes the defaults for FormItem AutoChildren named `autoChildName`.
    `protected com.google.gwt.core.client.JavaScriptObject` | `create()`
    `IButton` | `getAddLevelButton()` Automatically generated `IButton` providing a mechanism for adding new levels to the group configuration.
    `java.lang.String` | `getAddLevelButtonTitle()` The title-text to appear on the addLevelButton.
    `IButton` | `getApplyButton()` Automatically generated `IButton` providing the mechanism for accepting the current group configuration.
    `java.lang.String` | `getApplyButtonTitle()` The title-text to appear on the applyButton
    `IButton` | `getCancelButton()` Automatically generated `IButton` providing the mechanism for closing this Dialog without accepting the current group configuration.
    `java.lang.String` | `getCancelButtonTitle()` The title-text to appear on the cancelButton
    `IButton` | `getCopyLevelButton()` Automatically generated `IButton` providing a mechanism for duplicating levels in the group configuration.
    `java.lang.String` | `getCopyLevelButtonTitle()` The title-text to appear on the copyLevelButton
    `IButton` | `getDeleteLevelButton()` Automatically generated `IButton` providing a mechanism for deleting levels from the group configuration.
    `java.lang.String` | `getDeleteLevelButtonTitle()` The title-text to appear on the deleteLevelButton
    `java.lang.String` | `getGroupingFieldTitle()` The title-text to appear in the header of the "property" field.
    `java.lang.String` | `getInvalidListPrompt()` This is a dynamic string - text within `\${...}` will be evaluated as JS code when the message is displayed.
    `ImgButton` | `getLevelDownButton()` Automatically generated `ImgButton` providing a mechanism for moving existing group-levels down in the group configuration.
    `java.lang.String` | `getLevelDownButtonTitle()` The hover-prompt for the Level Down button.
    `ImgButton` | `getLevelUpButton()` Automatically generated `ImgButton` providing a mechanism for moving existing group-levels up in the group configuration.
    `java.lang.String` | `getLevelUpButtonTitle()` The hover-prompt for the Level Up button.
    `com.smartgwt.logicalstructure.core.LogicalStructureObject` | `getLogicalStructure()`
    `java.lang.Integer` | `getMaxLevels()` The maximum number of levels of grouping that can be applied.
    `int` | `getNumLevels()` Return the number of levels of grouping that have been configured.
    `ListGrid` | `getOptionsGrid()` Automatically generated `ListGrid` allowing the user to configure a set of GroupSpecifiers.
    `static MultiGroupDialog` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `java.lang.String` | `getPropertyFieldTitle()` The title-text to appear in the header of the "property" field.
    `java.lang.String` | `getTitle()` The title-text to appear in this Dialog's Header-bar.
    `void` | `setAddLevelButtonTitle(java.lang.String addLevelButtonTitle)` The title-text to appear on the addLevelButton.
    `void` | `setApplyButtonTitle(java.lang.String applyButtonTitle)` The title-text to appear on the applyButton
    `void` | `setCancelButtonTitle(java.lang.String cancelButtonTitle)` The title-text to appear on the cancelButton
    `void` | `setCopyLevelButtonTitle(java.lang.String copyLevelButtonTitle)` The title-text to appear on the copyLevelButton
    `static void` | `setDefaultProperties(MultiGroupDialog multiGroupDialogProperties)` Class level method to set the default properties of this class.
    `void` | `setDeleteLevelButtonTitle(java.lang.String deleteLevelButtonTitle)` The title-text to appear on the deleteLevelButton
    `void` | `setGroupingFieldTitle(java.lang.String groupingFieldTitle)` The title-text to appear in the header of the "property" field.
    `void` | `setInvalidListPrompt(java.lang.String invalidListPrompt)` This is a dynamic string - text within `\${...}` will be evaluated as JS code when the message is displayed.
    `void` | `setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `void` | `setLevelDownButtonTitle(java.lang.String levelDownButtonTitle)` The hover-prompt for the Level Down button.
    `void` | `setLevelUpButtonTitle(java.lang.String levelUpButtonTitle)` The hover-prompt for the Level Up button.
    `com.smartgwt.logicalstructure.core.LogicalStructureObject` | `setLogicalStructure(com.smartgwt.logicalstructure.widgets.MultiGroupDialogLogicalStructure s)`
    `void` | `setMaxLevels(java.lang.Integer maxLevels)` The maximum number of levels of grouping that can be applied.
    `void` | `setPropertyFieldTitle(java.lang.String propertyFieldTitle)` The title-text to appear in the header of the "property" field.
    `void` | `setTitle(java.lang.String title)` The title-text to appear in this Dialog's Header-bar.
    `boolean` | `validate()` Validate that no two GroupSpecifiers group on the same property.

    - ### Methods inherited from class com.smartgwt.client.widgets.Window

      `addCloseClickHandler, addItem, addItem, addMaximizeClickHandler, addMember, addMember, addMinimizeClickHandler, addRestoreClickHandler, centerInPage, close, flash, getAnimateMinimize, getAutoCenter, getAutoSize, getBody, getBodyColor, getBodyStyle, getCanDragReposition, getCanDragResize, getCanFocusInHeaderButtons, getCloseButton, getContentLayout, getContentsType, getDefaultMinimizeHeight, getDismissOnEscape, getDismissOnOutsideClick, getFooter, getFooterHeight, getHeader, getHeaderBackground, getHeaderIcon, getHeaderLabel, getHeaderSrc, getHeaderStyle, getHiliteBodyColor, getHiliteHeaderSrc, getHiliteHeaderStyle, getIsModal, getItems, getMaximizeButton, getMaximized, getMinimizeAcceleration, getMinimizeButton, getMinimized, getMinimizeHeight, getMinimizeTime, getModalMask, getModalMaskOpacity, getModalMaskStyle, getOpacity, getResizer, getRestoreButton, getShowBody, getShowCloseButton, getShowFooter, getShowHeader, getShowHeaderBackground, getShowHeaderIcon, getShowMaximizeButton, getShowMinimizeButton, getShowModalMask, getShowResizer, getShowStatusBar, getShowTitle, getSrc, getStatus, getStatusBar, getUseBackMask, maximize, minimize, onCloseClick, preloadImages, removeItem, restore, setAnimateMinimize, setAutoCenter, setAutoSize, setBodyColor, setBodyDefaults, setBodyStyle, setCanDragReposition, setCanDragResize, setCanFocusInHeaderButtons, setContentLayout, setContentsType, setDefaultMinimizeHeight, setDefaultProperties, setDismissOnEscape, setDismissOnOutsideClick, setFooterControls, setFooterHeight, setHeaderControls, setHeaderIcon, setHeaderIcon, setHeaderIconDefaults, setHeaderIconProperties, setHeaderSrc, setHeaderStyle, setHiliteBodyColor, setHiliteHeaderSrc, setHiliteHeaderStyle, setIsModal, setKeepInParentRect, setKeepInParentRect, setLogicalStructure, setMaximized, setMinimizeAcceleration, setMinimized, setMinimizeHeight, setMinimizeTime, setModalMaskOpacity, setModalMaskStyle, setOpacity, setShowBody, setShowCloseButton, setShowFooter, setShowHeader, setShowHeaderBackground, setShowHeaderIcon, setShowMaximizeButton, setShowMinimizeButton, setShowModalMask, setShowResizer, setShowStatusBar, setShowTitle, setSrc, setStatus, setUseBackMask, shouldDismissOnEscape`

    - ### 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, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOffset, getMemberOverlap, getMembers, getMembersMargin, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, membersChanged, onInit_Layout, onInit, reflow, reflow, reflowNow, removeMember, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setLeaveScrollbarGap, 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, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, 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, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, 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, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, 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, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setPadding, setPageLeft, setPageTop, 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, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTooltip, setTop, setTop, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop`

    - ### 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, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, 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, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, 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`

- - ### Constructor Detail

    - #### MultiGroupDialog

          public MultiGroupDialog()

    - #### MultiGroupDialog

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

  - ### Method Detail

    - #### getOrCreateRef

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

    - #### setJavaScriptObject

          public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)

      Overrides:
        `setJavaScriptObject` in class `Window`

    - #### changeAutoChildDefaults

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

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

    - #### changeAutoChildDefaults

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

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

    - #### create

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

      Overrides:
        `create` in class `Window`

    - #### getAddLevelButton

          public IButton getAddLevelButton()
                                    throws java.lang.IllegalStateException

      Automatically generated `IButton` providing a mechanism for adding new levels to the group configuration.

      This component is an AutoChild and as such may be customized via `multiGroupPanel.addLevelButtonProperties` and `multiGroupPanel.addLevelButtonDefaults`.

      For an overview of how to use and configure AutoChildren, see `Using AutoChildren`.

      Returns:
        IButton
      Throws:
        `java.lang.IllegalStateException` - if this widget has not yet been rendered.

    - #### setAddLevelButtonTitle

          public void setAddLevelButtonTitle(java.lang.String addLevelButtonTitle)
                                      throws java.lang.IllegalStateException

      The title-text to appear on the addLevelButton.

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Parameters:
        `addLevelButtonTitle` - . See `String`. Default value is "Add Level"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getAddLevelButtonTitle

          public java.lang.String getAddLevelButtonTitle()

      The title-text to appear on the addLevelButton.

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Returns:
        . See `String`

    - #### getApplyButton

          public IButton getApplyButton()
                                 throws java.lang.IllegalStateException

      Automatically generated `IButton` providing the mechanism for accepting the current group configuration. Fires the passed callback with a single parameter, groupLevels, representing the current group configuration as an array of GroupSpecifiers.

      This component is an AutoChild and as such may be customized via `multiGroupPanel.applyButtonProperties` and `multiGroupPanel.applyButtonDefaults`.

      For an overview of how to use and configure AutoChildren, see `Using AutoChildren`.

      Returns:
        IButton
      Throws:
        `java.lang.IllegalStateException` - if this widget has not yet been rendered.

    - #### setApplyButtonTitle

          public void setApplyButtonTitle(java.lang.String applyButtonTitle)
                                   throws java.lang.IllegalStateException

      The title-text to appear on the applyButton
      Parameters:
        `applyButtonTitle` - . See `String`. Default value is "Apply"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getApplyButtonTitle

          public java.lang.String getApplyButtonTitle()

      The title-text to appear on the applyButton
      Returns:
        . See `String`

    - #### getCancelButton

          public IButton getCancelButton()
                                  throws java.lang.IllegalStateException

      Automatically generated `IButton` providing the mechanism for closing this Dialog without accepting the current group configuration. The passed callback is fired with a single null parameter, indicating that the operation was cancelled.

      This component is an AutoChild and as such may be customized via `multiGroupPanel.cancelButtonProperties` and `multiGroupPanel.cancelButtonDefaults`.

      For an overview of how to use and configure AutoChildren, see `Using AutoChildren`.

      Returns:
        IButton
      Throws:
        `java.lang.IllegalStateException` - if this widget has not yet been rendered.

    - #### setCancelButtonTitle

          public void setCancelButtonTitle(java.lang.String cancelButtonTitle)
                                    throws java.lang.IllegalStateException

      The title-text to appear on the cancelButton
      Parameters:
        `cancelButtonTitle` - . See `String`. Default value is "Cancel"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getCancelButtonTitle

          public java.lang.String getCancelButtonTitle()

      The title-text to appear on the cancelButton
      Returns:
        . See `String`

    - #### getCopyLevelButton

          public IButton getCopyLevelButton()
                                     throws java.lang.IllegalStateException

      Automatically generated `IButton` providing a mechanism for duplicating levels in the group configuration.

      This component is an AutoChild and as such may be customized via `multiGroupPanel.copyLevelButtonProperties` and `multiGroupPanel.copyLevelButtonDefaults`.

      For an overview of how to use and configure AutoChildren, see `Using AutoChildren`.

      Returns:
        IButton
      Throws:
        `java.lang.IllegalStateException` - if this widget has not yet been rendered.

    - #### setCopyLevelButtonTitle

          public void setCopyLevelButtonTitle(java.lang.String copyLevelButtonTitle)
                                       throws java.lang.IllegalStateException

      The title-text to appear on the copyLevelButton

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Parameters:
        `copyLevelButtonTitle` - . See `String`. Default value is "Copy Level"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getCopyLevelButtonTitle

          public java.lang.String getCopyLevelButtonTitle()

      The title-text to appear on the copyLevelButton

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Returns:
        . See `String`

    - #### getDeleteLevelButton

          public IButton getDeleteLevelButton()
                                       throws java.lang.IllegalStateException

      Automatically generated `IButton` providing a mechanism for deleting levels from the group configuration.

      This component is an AutoChild and as such may be customized via `multiGroupPanel.deleteLevelButtonProperties` and `multiGroupPanel.deleteLevelButtonDefaults`.

      For an overview of how to use and configure AutoChildren, see `Using AutoChildren`.

      Returns:
        IButton
      Throws:
        `java.lang.IllegalStateException` - if this widget has not yet been rendered.

    - #### setDeleteLevelButtonTitle

          public void setDeleteLevelButtonTitle(java.lang.String deleteLevelButtonTitle)
                                         throws java.lang.IllegalStateException

      The title-text to appear on the deleteLevelButton

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Parameters:
        `deleteLevelButtonTitle` - . See `String`. Default value is "Delete Level"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getDeleteLevelButtonTitle

          public java.lang.String getDeleteLevelButtonTitle()

      The title-text to appear on the deleteLevelButton

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Returns:
        . See `String`

    - #### setGroupingFieldTitle

          public void setGroupingFieldTitle(java.lang.String groupingFieldTitle)
                                     throws java.lang.IllegalStateException

      The title-text to appear in the header of the "property" field.

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Parameters:
        `groupingFieldTitle` - . See `String`. Default value is "Grouping"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getGroupingFieldTitle

          public java.lang.String getGroupingFieldTitle()

      The title-text to appear in the header of the "property" field.

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Returns:
        . See `String`

    - #### setInvalidListPrompt

          public void setInvalidListPrompt(java.lang.String invalidListPrompt)
                                    throws java.lang.IllegalStateException

      This is a dynamic string - text within `\${...}` will be evaluated as JS code when the message is displayed.

      Default value returns

      `Columns may only be used once: `[some field's title]` is used multiple times`

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Parameters:
        `invalidListPrompt` - . See `String`. Default value is "Columns may only be used once: '\${title}' is used multiple times."
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getInvalidListPrompt

          public java.lang.String getInvalidListPrompt()

      This is a dynamic string - text within `\${...}` will be evaluated as JS code when the message is displayed.

      Default value returns

      `Columns may only be used once: `[some field's title]` is used multiple times`

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Returns:
        . See `String`

    - #### getLevelDownButton

          public ImgButton getLevelDownButton()
                                       throws java.lang.IllegalStateException

      Automatically generated `ImgButton` providing a mechanism for moving existing group-levels down in the group configuration.

      This component is an AutoChild and as such may be customized via `multiGroupPanel.levelDownButtonProperties` and `multiGroupPanel.levelDownButtonDefaults`.

      For an overview of how to use and configure AutoChildren, see `Using AutoChildren`.

      Returns:
        ImgButton
      Throws:
        `java.lang.IllegalStateException` - if this widget has not yet been rendered.

    - #### setLevelDownButtonTitle

          public void setLevelDownButtonTitle(java.lang.String levelDownButtonTitle)
                                       throws java.lang.IllegalStateException

      The hover-prompt for the Level Down button.
      Parameters:
        `levelDownButtonTitle` - . See `String`. Default value is "Move Level Down"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getLevelDownButtonTitle

          public java.lang.String getLevelDownButtonTitle()

      The hover-prompt for the Level Down button.
      Returns:
        . See `String`

    - #### getLevelUpButton

          public ImgButton getLevelUpButton()
                                     throws java.lang.IllegalStateException

      Automatically generated `ImgButton` providing a mechanism for moving existing group-levels up in the group configuration.

      This component is an AutoChild and as such may be customized via `multiGroupPanel.levelUpButtonProperties` and `multiGroupPanel.levelUpButtonDefaults`.

      For an overview of how to use and configure AutoChildren, see `Using AutoChildren`.

      Returns:
        ImgButton
      Throws:
        `java.lang.IllegalStateException` - if this widget has not yet been rendered.

    - #### setLevelUpButtonTitle

          public void setLevelUpButtonTitle(java.lang.String levelUpButtonTitle)
                                     throws java.lang.IllegalStateException

      The hover-prompt for the Level Up button.
      Parameters:
        `levelUpButtonTitle` - . See `String`. Default value is "Move Level Up"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getLevelUpButtonTitle

          public java.lang.String getLevelUpButtonTitle()

      The hover-prompt for the Level Up button.
      Returns:
        . See `String`

    - #### setMaxLevels

          public void setMaxLevels(java.lang.Integer maxLevels)
                            throws java.lang.IllegalStateException

      The maximum number of levels of grouping that can be applied. Since each group-property or field-name can be used only once in a given multi-group operation, if no maxLevels value or a value larger than the total number of available properties is specified, it will default to the total number of available properties.

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog.

      Parameters:
        `maxLevels` - maxLevels Default value is null
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getMaxLevels

          public java.lang.Integer getMaxLevels()

      The maximum number of levels of grouping that can be applied. Since each group-property or field-name can be used only once in a given multi-group operation, if no maxLevels value or a value larger than the total number of available properties is specified, it will default to the total number of available properties.

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog.

      Returns:
        Integer

    - #### getOptionsGrid

          public ListGrid getOptionsGrid()
                                  throws java.lang.IllegalStateException

      Automatically generated `ListGrid` allowing the user to configure a set of GroupSpecifiers.

      This component is an AutoChild and as such may be customized via `multiGroupPanel.optionsGridProperties` and `multiGroupPanel.optionsGridDefaults`.

      For an overview of how to use and configure AutoChildren, see `Using AutoChildren`.

      Returns:
        ListGrid
      Throws:
        `java.lang.IllegalStateException` - if this widget has not yet been rendered.

    - #### setPropertyFieldTitle

          public void setPropertyFieldTitle(java.lang.String propertyFieldTitle)
                                     throws java.lang.IllegalStateException

      The title-text to appear in the header of the "property" field.

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Parameters:
        `propertyFieldTitle` - . See `String`. Default value is "Column"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getPropertyFieldTitle

          public java.lang.String getPropertyFieldTitle()

      The title-text to appear in the header of the "property" field.

      Note, this is a passthrough property which, when set, is passed through to the MultiGroupPanel contained in this dialog. You only need to consider the properties on the MultiGroupPanel for i18n.

      Returns:
        . See `String`

    - #### setTitle

          public void setTitle(java.lang.String title)
                        throws java.lang.IllegalStateException

      The title-text to appear in this Dialog's Header-bar.
      Overrides:
        `setTitle` in class `Window`
      Parameters:
        `title` - . See `String`. Default value is "Group"
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created
      See Also:
        `Appearance overview and related methods`

    - #### getTitle

          public java.lang.String getTitle()

      The title-text to appear in this Dialog's Header-bar.
      Overrides:
        `getTitle` in class `Window`
      Returns:
        . See `String`
      See Also:
        `Appearance overview and related methods`

    - #### getNumLevels

          public int getNumLevels()

      Return the number of levels of grouping that have been configured.
      Returns:
        The number of levels of grouping that have been configured

    - #### validate

          public boolean validate()

      Validate that no two GroupSpecifiers group on the same property.
      Returns:
        True if validation succeeds, false if any property is used twice

    - #### setDefaultProperties

          public static void setDefaultProperties(MultiGroupDialog multiGroupDialogProperties)

      Class level method to set the default properties of this class. If set, then all subsequent instances of this class will automatically have the default properties that were set when this method was called. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

      Note: This method is intended for setting default attributes only and will effect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead.

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

    - #### setLogicalStructure

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

    - #### getLogicalStructure

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

      Specified by:
        `getLogicalStructure` in interface `LogicalStructure`
      Overrides:
        `getLogicalStructure` in class `Window`