InteractionDialog (Codename One API)

java.lang.Object
- com.codename1.ui.Component
- - com.codename1.ui.Container
  - - com.codename1.components.InteractionDialog

All Implemented Interfaces:

Animation, Editable, StyleListener, Iterable<Component>
```
public class InteractionDialog
extends Container
```
Unlike a regular dialog the interaction dialog only looks like a dialog, it resides in the layered pane and can be used to implement features where interaction with the background form is still required.
Since this code is designed for interaction all "dialogs" created thru here are modless and never block.

Constructor Summary

Constructors
Constructor and Description
`InteractionDialog()` Default constructor with no title
`InteractionDialog(Layout l)` Default constructor with layout
`InteractionDialog(String title)` Constructor with dialog title
`InteractionDialog(String title, Layout l)` Constructor with dialog title

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addComponent(Component cmp)` Adds a Component to the Container
`void`	`addComponent(int index, Component cmp)` This method adds the Component at a specific index location in the Container Components array.
`void`	`addComponent(int index, Object constraints, Component cmp)` Adds a Component to the Container
`void`	`addComponent(Object constraints, Component cmp)` Adds a Component to the Container
`protected void`	`deinitialize()` Invoked to indicate that the component initialization is being reversed since the component was detached from the container hierarchy.
`void`	`dispose()` Removes the interaction dialog from view
`void`	`disposeToTheBottom()` Removes the interaction dialog from view with an animation to the bottom
`void`	`disposeToTheBottom(Runnable onFinish)` Removes the interaction dialog from view with an animation to the bottom
`void`	`disposeToTheLeft()` Removes the interaction dialog from view with an animation to the left
`void`	`disposeToTheRight()` Removes the interaction dialog from view with an animation to the right
`void`	`disposeToTheTop()` Removes the interaction dialog from view with an animation to the top
`Container`	`getContentPane()` Returns the body of the interaction dialog
`Style`	`getDialogStyle()` Simple getter to get the Dialog Style
`String`	`getDialogUIID()` Returns the uiid of the dialog
`Layout`	`getLayout()` Returns the layout manager responsible for arranging this container.
`String`	`getTitle()`
`Label`	`getTitleComponent()`
`protected void`	`initComponent()` Allows subclasses to bind functionality that relies on fully initialized and "ready for action" component state
`boolean`	`isAnimateShow()` Indicates whether show/dispose should be animated or not
`boolean`	`isDisposeWhenPointerOutOfBounds()` This flag indicates if the dialog should be disposed if a pointer released event occurred out of the dialog content.
`boolean`	`isFormMode()` Whether the interaction dialog uses the form layered pane of the regular layered pane
`boolean`	`isRepositionAnimation()` Repositions the component so the animation will "grow/shrink" when showing/disposing
`boolean`	`isShowing()` Will return true if the dialog is currently showing
`void`	`removeAll()` remove all Components from container, notice that removed component might still have a pending repaint in the queue that won't be removed.
`void`	`removeComponent(Component cmp)` removes a Component from the Container, notice that removed component might still have a pending repaint in the queue that won't be removed.
`void`	`resize(int top, int bottom, int left, int right)`
`void`	`setAnimateShow(boolean animateShow)` Indicates whether show/dispose should be animated or not
`void`	`setDialogUIID(String uiid)` Simple setter to set the Dialog uiid
`void`	`setDisposeWhenPointerOutOfBounds(boolean disposeWhenPointerOutOfBounds)` This flag indicates if the dialog should be disposed if a pointer released event occurred out of the dialog content.
`void`	`setFormMode(boolean formMode)` Whether the interaction dialog uses the form layered pane of the regular layered pane
`void`	`setLayout(Layout layout)` Sets the layout manager responsible for arranging this container
`void`	`setRepositionAnimation(boolean repositionAnimation)` Repositions the component so the animation will "grow/shrink" when showing/disposing
`void`	`setScrollable(boolean scrollable)` The equivalent of calling both setScrollableY and setScrollableX
`void`	`setTitle(String title)`
`void`	`show(int top, int bottom, int left, int right)` This method shows the form as a modal alert allowing us to produce a behavior of an alert/dialog box.
`void`	`showPopupDialog(Component c)` A popup dialog is shown with the context of a component and its selection.
`void`	`showPopupDialog(Component c, boolean bias)` A popup dialog is shown with the context of a component and its selection.
`void`	`showPopupDialog(Rectangle rect)` A popup dialog is shown with the context of a component and its selection.
`void`	`showPopupDialog(Rectangle rect, boolean bias)` A popup dialog is shown with the context of a component and its selection.

Methods inherited from class com.codename1.ui.Container
add, add, add, add, add, add, addAll, animateHierarchy, animateHierarchyAndWait, animateHierarchyFade, animateHierarchyFadeAndWait, animateLayout, animateLayoutAndWait, animateLayoutFade, animateLayoutFadeAndWait, animateUnlayout, animateUnlayoutAndWait, applyRTL, calcPreferredSize, cancelRepaints, clearClientProperties, constrainHeightWhenScrollable, constrainWidthWhenScrollable, contains, createAnimateHierarchy, createAnimateHierarchyFade, createAnimateLayout, createAnimateLayoutFade, createAnimateLayoutFadeAndWait, createAnimateMotion, createAnimateUnlayout, createReplaceTransition, dragInitiated, drop, encloseIn, encloseIn, findDropTargetAt, findFirstFocusable, fireClicked, flushReplace, forceRevalidate, getBottomGap, getChildrenAsList, getClosestComponentTo, getComponentAt, getComponentAt, getComponentCount, getComponentIndex, getGridPosX, getGridPosY, getLayoutHeight, getLayoutWidth, getLeadComponent, getLeadParent, getResponderAt, getSafeAreaRoot, getScrollIncrement, getSideGap, getUIManager, initLaf, invalidate, isEnabled, isSafeArea, isSafeAreaRoot, isScrollableX, isScrollableY, isSelectableInteraction, isSurface, iterator, iterator, keyPressed, keyReleased, layoutContainer, morph, morphAndWait, paint, paintBackground, paintBorderBackground, paintComponentBackground, paintGlass, paramString, pointerPressed, refreshTheme, replace, replace, replaceAndWait, replaceAndWait, replaceAndWait, revalidate, revalidateLater, revalidateWithAnimationSafety, scrollComponentToVisible, setCellRenderer, setEnabled, setLeadComponent, setSafeArea, setSafeAreaRoot, setScrollableX, setScrollableY, setScrollIncrement, setShouldCalcPreferredSize, setShouldLayout, setUIManager, updateTabIndices

Methods inherited from class com.codename1.ui.Component
addDragFinishedListener, addDragOverListener, addDropListener, addFocusListener, addLongPressListener, addPointerDraggedListener, addPointerPressedListener, addPointerReleasedListener, addPullToRefresh, addScrollListener, addStateChangeListener, animate, bindProperty, blocksSideSwipe, calcScrollSize, contains, containsOrOwns, createStyleAnimation, deinitializeCustomStyle, dragEnter, dragExit, dragFinished, draggingOver, drawDraggedImage, focusGained, focusLost, getAbsoluteX, getAbsoluteY, getAllStyles, getAnimationManager, getBaseline, getBaselineResizeBehavior, getBindablePropertyNames, getBindablePropertyTypes, getBorder, getBoundPropertyValue, getBounds, getBounds, getClientProperty, getCloudBoundProperty, getCloudDestinationProperty, getComponentForm, getComponentState, getCursor, getDirtyRegion, getDisabledStyle, getDraggedx, getDraggedy, getDragImage, getDragRegionStatus, getDragSpeed, getEditingDelegate, getHeight, getInlineAllStyles, getInlineDisabledStyles, getInlinePressedStyles, getInlineSelectedStyles, getInlineStylesTheme, getInlineUnselectedStyles, getInnerHeight, getInnerPreferredH, getInnerPreferredW, getInnerWidth, getInnerX, getInnerY, getLabelForComponent, getName, getNativeOverlay, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getOuterHeight, getOuterPreferredH, getOuterPreferredW, getOuterWidth, getOuterX, getOuterY, getOwner, getParent, getPreferredH, getPreferredSize, getPreferredSizeStr, getPreferredTabIndex, getPreferredW, getPressedStyle, getPropertyNames, getPropertyTypeNames, getPropertyTypes, getPropertyValue, getSameHeight, getSameWidth, getScrollable, getScrollAnimationSpeed, getScrollDimension, getScrollOpacity, getScrollOpacityChangeSpeed, getScrollX, getScrollY, getSelectCommandText, getSelectedRect, getSelectedStyle, getStyle, getTabIndex, getTensileLength, getTextSelectionSupport, getTooltip, getUIID, getUnselectedStyle, getVisibleBounds, getVisibleBounds, getWidth, getX, getY, growShrink, handlesInput, hasFixedPreferredSize, hasFocus, hideNativeOverlay, initCustomStyle, initDisabledStyle, initPressedStyle, initSelectedStyle, initUnselectedStyle, installDefaultPainter, isAlwaysTensile, isBlockLead, isCellRenderer, isChildOf, isDragActivated, isDragAndDropOperation, isDraggable, isDragRegion, isDropTarget, isEditable, isEditing, isFlatten, isFocusable, isGrabsPointerEvents, isHidden, isHidden, isHideInLandscape, isHideInPortrait, isIgnorePointerEvents, isInClippingRegion, isInitialized, isOpaque, isOwnedBy, isRippleEffect, isRTL, isScrollable, isScrollVisible, isSetCursorSupported, isSmoothScrolling, isSnapToGrid, isStickyDrag, isTactileTouch, isTactileTouch, isTensileDragEnabled, isTraversable, isVisible, keyRepeated, laidOut, longKeyPress, longPointerPress, onScrollX, onScrollY, paintBackgrounds, paintBorder, paintComponent, paintComponent, paintIntersectingComponentsAbove, paintLock, paintLockRelease, paintRippleOverlay, paintScrollbars, paintScrollbarX, paintScrollbarY, paintShadows, parsePreferredSize, pinch, pinchReleased, pointerDragged, pointerDragged, pointerHover, pointerHoverPressed, pointerHoverReleased, pointerPressed, pointerReleased, pointerReleased, putClientProperty, refreshTheme, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removeLongPressListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, removeStateChangeListener, repaint, repaint, requestFocus, resetFocusable, respondsToPointerEvents, scrollRectToVisible, scrollRectToVisible, setAlwaysTensile, setBlockLead, setBoundPropertyValue, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setCursor, setDirtyRegion, setDisabledStyle, setDraggable, setDropTarget, setEditingDelegate, setFlatten, setFocus, setFocusable, setGrabsPointerEvents, setHandlesInput, setHeight, setHidden, setHidden, setHideInLandscape, setHideInPortrait, setIgnorePointerEvents, setInitialized, setInlineAllStyles, setInlineDisabledStyles, setInlinePressedStyles, setInlineSelectedStyles, setInlineStylesTheme, setInlineUnselectedStyles, setIsScrollVisible, setLabelForComponent, setName, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setOpaque, setOwner, setPreferredH, setPreferredSize, setPreferredSizeStr, setPreferredTabIndex, setPreferredW, setPressedStyle, setPropertyValue, setRippleEffect, setRTL, setSameHeight, setSameSize, setSameWidth, setScrollAnimationSpeed, setScrollOpacityChangeSpeed, setScrollSize, setScrollVisible, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setSize, setSmoothScrolling, setSnapToGrid, setTabIndex, setTactileTouch, setTensileDragEnabled, setTensileLength, setTooltip, setTraversable, setUIID, setUIID, setUnselectedStyle, setVisible, setWidth, setX, setY, shouldBlockSideSwipe, shouldBlockSideSwipeLeft, shouldBlockSideSwipeRight, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, styleChanged, toImage, toString, unbindProperty, updateNativeOverlay, visibleBoundsContains

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InteractionDialog
```
public InteractionDialog()
```
    Default constructor with no title
  - InteractionDialog
```
public InteractionDialog(Layout l)
```
    Default constructor with layout
    
    Parameters:
    
    l - layout
  - InteractionDialog
```
public InteractionDialog(String title)
```
    Constructor with dialog title
    
    Parameters:
    
    title - the title of the dialog
  - InteractionDialog
```
public InteractionDialog(String title,
                         Layout l)
```
    Constructor with dialog title
    
    Parameters:
    
    title - the title of the dialog
    
    l - the layout for the content pane
- Method Detail
  - initComponent
```
protected void initComponent()
```
    Description copied from class: Component
    
    Allows subclasses to bind functionality that relies on fully initialized and "ready for action" component state
    
    Overrides:
    
    initComponent in class Component
  - setDisposeWhenPointerOutOfBounds
```
public void setDisposeWhenPointerOutOfBounds(boolean disposeWhenPointerOutOfBounds)
```
    This flag indicates if the dialog should be disposed if a pointer released event occurred out of the dialog content.
    
    Parameters:
    
    disposeWhenPointerOutOfBounds -
  - isDisposeWhenPointerOutOfBounds
```
public boolean isDisposeWhenPointerOutOfBounds()
```
    This flag indicates if the dialog should be disposed if a pointer released event occurred out of the dialog content.
    
    Returns:
    
    true if the dialog should dispose
  - getContentPane
```
public Container getContentPane()
```
    Returns the body of the interaction dialog
    
    Returns:
    
    the container where the elements of the interaction dialog are added.
  - setScrollable
```
public void setScrollable(boolean scrollable)
```
    The equivalent of calling both setScrollableY and setScrollableX
    
    Overrides:
    
    setScrollable in class Container
    
    Parameters:
    
    scrollable - whether the component should/could scroll on the X and Y axis
  - getLayout
```
public Layout getLayout()
```
    Returns the layout manager responsible for arranging this container.
    
    Overrides:
    
    getLayout in class Container
    
    Returns:
    
    the container layout manager
  - getTitle
```
public String getTitle()
```
  - addComponent
```
public void addComponent(Component cmp)
```
    Adds a Component to the Container
    
    Overrides:
    
    addComponent in class Container
    
    Parameters:
    
    cmp - the component to be added
  - addComponent
```
public void addComponent(Object constraints,
                         Component cmp)
```
    Adds a Component to the Container
    
    Overrides:
    
    addComponent in class Container
    
    Parameters:
    
    constraints - this method is useful when the Layout requires a constraint such as the BorderLayout. In this case you need to specify an additional data when you add a Component, such as "CENTER", "NORTH"...
    
    cmp - component to add
  - addComponent
```
public void addComponent(int index,
                         Object constraints,
                         Component cmp)
```
    Adds a Component to the Container
    
    Overrides:
    
    addComponent in class Container
    
    Parameters:
    
    index - location to insert the Component
    
    constraints - this method is useful when the Layout requires a constraint such as the BorderLayout. In this case you need to specify an additional data when you add a Component, such as "CENTER", "NORTH"...
    
    cmp - component to add
  - addComponent
```
public void addComponent(int index,
                         Component cmp)
```
    This method adds the Component at a specific index location in the Container Components array.
    
    Overrides:
    
    addComponent in class Container
    
    Parameters:
    
    index - location to insert the Component
    
    cmp - the Component to add
  - removeAll
```
public void removeAll()
```
    remove all Components from container, notice that removed component might still have a pending repaint in the queue that won't be removed. Calling form.repaint() will workaround such an issue. Notice that this method doesn't recurse and only removes from the current container.
    
    Overrides:
    
    removeAll in class Container
  - removeComponent
```
public void removeComponent(Component cmp)
```
    removes a Component from the Container, notice that removed component might still have a pending repaint in the queue that won't be removed. Calling form.repaint() will workaround such an issue.
    
    Overrides:
    
    removeComponent in class Container
    
    Parameters:
    
    cmp - the removed component
  - getTitleComponent
```
public Label getTitleComponent()
```
  - setLayout
```
public void setLayout(Layout layout)
```
    Sets the layout manager responsible for arranging this container
    
    Overrides:
    
    setLayout in class Container
    
    Parameters:
    
    layout - the specified layout manager
  - setTitle
```
public void setTitle(String title)
```
  - deinitialize
```
protected void deinitialize()
```
    Invoked to indicate that the component initialization is being reversed since the component was detached from the container hierarchy. This allows the component to deregister animators and cleanup after itself. This method is the opposite of the initComponent() method.
    
    Overrides:
    
    deinitialize in class Component
  - resize
```
public void resize(int top,
                   int bottom,
                   int left,
                   int right)
```
  - show
```
public void show(int top,
                 int bottom,
                 int left,
                 int right)
```
    This method shows the form as a modal alert allowing us to produce a behavior of an alert/dialog box. This method will block the calling thread even if the calling thread is the EDT. Notice that this method will not release the block until dispose is called even if show() from another form is called!
    Modal dialogs Allow the forms "content" to "hang in mid air" this is especially useful for dialogs where you would want the underlying form to "peek" from behind the form.
    
    Parameters:
    
    top - space in pixels between the top of the screen and the form
    
    bottom - space in pixels between the bottom of the screen and the form
    
    left - space in pixels between the left of the screen and the form
    
    right - space in pixels between the right of the screen and the form
  - dispose
```
public void dispose()
```
    Removes the interaction dialog from view
  - disposeToTheLeft
```
public void disposeToTheLeft()
```
    Removes the interaction dialog from view with an animation to the left
  - disposeToTheBottom
```
public void disposeToTheBottom()
```
    Removes the interaction dialog from view with an animation to the bottom
  - disposeToTheBottom
```
public void disposeToTheBottom(Runnable onFinish)
```
    Removes the interaction dialog from view with an animation to the bottom
    
    Parameters:
    
    onFinish - Callback called when dispose animation is complete.
  - disposeToTheTop
```
public void disposeToTheTop()
```
    Removes the interaction dialog from view with an animation to the top
  - disposeToTheRight
```
public void disposeToTheRight()
```
    Removes the interaction dialog from view with an animation to the right
  - isShowing
```
public boolean isShowing()
```
    Will return true if the dialog is currently showing
    
    Returns:
    
    true if showing
  - isAnimateShow
```
public boolean isAnimateShow()
```
    Indicates whether show/dispose should be animated or not
    
    Returns:
    
    the animateShow
  - setAnimateShow
```
public void setAnimateShow(boolean animateShow)
```
    Indicates whether show/dispose should be animated or not
    
    Parameters:
    
    animateShow - the animateShow to set
  - showPopupDialog
```
public void showPopupDialog(Component c)
```
    A popup dialog is shown with the context of a component and its selection. You should use setDisposeWhenPointerOutOfBounds(boolean) to make it dispose when the user clicks outside the bounds of the popup. It can optionally provide an arrow in the theme to point at the context component. The popup dialog has the PopupDialog style by default.
    
    Parameters:
    
    c - the context component which is used to position the dialog and can also be pointed at
  - showPopupDialog
```
public void showPopupDialog(Component c,
                            boolean bias)
```
    A popup dialog is shown with the context of a component and its selection. You should use setDisposeWhenPointerOutOfBounds(boolean) to make it dispose when the user clicks outside the bounds of the popup. It can optionally provide an arrow in the theme to point at the context component. The popup dialog has the PopupDialog style by default.
    
    Parameters:
    
    c - the context component which is used to position the dialog and can also be pointed at
    
    bias - biases the dialog to appear above/below or to the sides. This is ignored if there isn't enough space
  - showPopupDialog
```
public void showPopupDialog(Rectangle rect)
```
    A popup dialog is shown with the context of a component and its selection. You should use setDisposeWhenPointerOutOfBounds(boolean) to make it dispose when the user clicks outside the bounds of the popup. It can optionally provide an arrow in the theme to point at the context component. The popup dialog has the PopupDialog style by default.
    
    Parameters:
    
    rect - the screen rectangle to which the popup should point
  - showPopupDialog
```
public void showPopupDialog(Rectangle rect,
                            boolean bias)
```
    A popup dialog is shown with the context of a component and its selection. You should use setDisposeWhenPointerOutOfBounds(boolean) to make it dispose when the user clicks outside the bounds of the popup. It can optionally provide an arrow in the theme to point at the context component. The popup dialog has the PopupDialog style by default.
    
    Parameters:
    
    rect - the screen rectangle to which the popup should point
    
    bias - biases the dialog to appear above/below or to the sides. This is ignored if there isn't enough space
  - setDialogUIID
```
public void setDialogUIID(String uiid)
```
    Simple setter to set the Dialog uiid
    
    Parameters:
    
    uiid - the id for the dialog
  - getDialogUIID
```
public String getDialogUIID()
```
    Returns the uiid of the dialog
    
    Returns:
    
    the uiid of the dialog
  - getDialogStyle
```
public Style getDialogStyle()
```
    Simple getter to get the Dialog Style
    
    Returns:
    
    the style of the dialog
  - isRepositionAnimation
```
public boolean isRepositionAnimation()
```
    Repositions the component so the animation will "grow/shrink" when showing/disposing
    
    Returns:
    
    the repositionAnimation
  - setRepositionAnimation
```
public void setRepositionAnimation(boolean repositionAnimation)
```
    Repositions the component so the animation will "grow/shrink" when showing/disposing
    
    Parameters:
    
    repositionAnimation - the repositionAnimation to set
  - isFormMode
```
public boolean isFormMode()
```
    Whether the interaction dialog uses the form layered pane of the regular layered pane
    
    Returns:
    
    the formMode
  - setFormMode
```
public void setFormMode(boolean formMode)
```
    Whether the interaction dialog uses the form layered pane of the regular layered pane
    
    Parameters:
    
    formMode - the formMode to set

Class InteractionDialog

Field Summary

Fields inherited from class com.codename1.ui.Component

Constructor Summary

Method Summary

Methods inherited from class com.codename1.ui.Container

Methods inherited from class com.codename1.ui.Component

Methods inherited from class java.lang.Object

Constructor Detail

InteractionDialog

InteractionDialog

InteractionDialog

InteractionDialog

Method Detail

initComponent

setDisposeWhenPointerOutOfBounds

isDisposeWhenPointerOutOfBounds

getContentPane

setScrollable

getLayout

getTitle

addComponent

addComponent

addComponent

addComponent

removeAll

removeComponent

getTitleComponent

setLayout

setTitle

deinitialize

resize

show

dispose

disposeToTheLeft

disposeToTheBottom

disposeToTheBottom

disposeToTheTop

disposeToTheRight

isShowing

isAnimateShow

setAnimateShow

showPopupDialog

showPopupDialog

showPopupDialog

showPopupDialog

setDialogUIID

getDialogUIID

getDialogStyle

isRepositionAnimation

setRepositionAnimation

isFormMode

setFormMode