DialogOptions (CUBA 7.0 API)

java.lang.Object
- com.haulmont.cuba.gui.DialogOptions

Deprecated.
Use Screen.getWindow() directly with cast to DialogWindow if needed.
```
@Deprecated
public class DialogOptions
extends java.lang.Object
```
Dialog options of a window. Can be changed at run time from the window controller:
```
 getDialogOptions()
     .setWidth("640px")
     .setHeight("480px");
 
```

Constructor Summary

Constructors
Constructor and Description

DialogOptions()
Deprecated.

Constructors
Constructor and Description
`DialogOptions()` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DialogOptions`	`center()` Deprecated. Center window only if it is already opened
`java.lang.Boolean`	`getCloseable()` Deprecated.
`java.lang.Boolean`	`getCloseOnClickOutside()` Deprecated.
`java.lang.Boolean`	`getForceDialog()` Deprecated.
`java.lang.Float`	`getHeight()` Deprecated.
`SizeUnit`	`getHeightUnit()` Deprecated.
`java.lang.Boolean`	`getMaximized()` Deprecated.
`java.lang.Boolean`	`getModal()` Deprecated.
`java.lang.Integer`	`getPositionX()` Deprecated.
`java.lang.Integer`	`getPositionY()` Deprecated.
`java.lang.Boolean`	`getResizable()` Deprecated.
`java.lang.Float`	`getWidth()` Deprecated.
`SizeUnit`	`getWidthUnit()` Deprecated.
`DialogOptions`	`setCloseable(java.lang.Boolean closeable)` Deprecated. Set closeable option if a window will be opened as a dialog or change closeable option if the window is already opened as a dialog.
`DialogOptions`	`setCloseOnClickOutside(java.lang.Boolean closeOnClickOutside)` Deprecated. Set closeOnClickOutside to true if a window should be closed by click on outside window area.
`DialogOptions`	`setForceDialog(java.lang.Boolean forceDialog)` Deprecated. Does not affect window open mode anymore. Use `DialogMode.forceDialog()` on controller class or set forceDialog attribute in XML descriptor.
`DialogOptions`	`setHeight(java.lang.Float height)` Deprecated. Set height of a window if it will be opened as a dialog or change height at run time if the window is already opened as a dialog.
`protected DialogOptions`	`setHeight(java.lang.Float height, SizeUnit unit)` Deprecated.
`DialogOptions`	`setHeight(java.lang.Integer height)` Deprecated. Use `setHeight(Float)` instead.
`DialogOptions`	`setHeight(java.lang.String height)` Deprecated. Sets the height of a window if it will be opened as a dialog using String presentation or change height at run time if the window is already opened as a dialog.
`DialogOptions`	`setHeightAuto()` Deprecated. Set height of a window to AUTO if it will be opened as a dialog or change height at run time if the window is already opened as a dialog.
`DialogOptions`	`setHeightUnit(SizeUnit heightUnit)` Deprecated. Sets the unit used for the height.
`DialogOptions`	`setMaximized(java.lang.Boolean maximized)` Deprecated. Set maximized to true if a window should be maximized across the screen.
`DialogOptions`	`setModal(java.lang.Boolean modal)` Deprecated. Set modal option if a window will be opened as a dialog or change modal option if the window is already opened as a dialog.
`DialogOptions`	`setPositionX(java.lang.Integer positionX)` Deprecated. Set the distance of Window left border in pixels from left border of the containing (main window).
`DialogOptions`	`setPositionY(java.lang.Integer positionY)` Deprecated. Sets the distance of Window left border in pixels from top border of the containing (main window).
`DialogOptions`	`setResizable(java.lang.Boolean resizable)` Deprecated. Set resizable option if a window will be opened as a dialog or change resizable option if the window is already opened as a dialog.
`DialogOptions`	`setWidth(java.lang.Float width)` Deprecated. Set width of a window if it will be opened as a dialog or change width at run time if the window is already opened as a dialog.
`protected DialogOptions`	`setWidth(java.lang.Float width, SizeUnit unit)` Deprecated.
`DialogOptions`	`setWidth(java.lang.Integer width)` Deprecated. Use `setWidth(Float)` instead.
`DialogOptions`	`setWidth(java.lang.String width)` Deprecated. Sets the width of a window if it will be opened as a dialog using String presentation or change width at run time if the window is already opened as a dialog.
`DialogOptions`	`setWidthAuto()` Deprecated. Set width of a window to AUTO if it will be opened as a dialog or change width at run time if the window is already opened as a dialog.
`DialogOptions`	`setWidthUnit(SizeUnit widthUnit)` Deprecated. Sets the unit used for the width.

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

- Constructor Detail
  - DialogOptions
```
public DialogOptions()
```
    Deprecated.
- Method Detail
  - getCloseable
```
public java.lang.Boolean getCloseable()
```
    Deprecated.
    
    Returns:
    
    true if a window is opened as a dialog and has close button or if set to true from the window controller
  - setCloseable
```
public DialogOptions setCloseable(java.lang.Boolean closeable)
```
    Deprecated.
    
    Set closeable option if a window will be opened as a dialog or change closeable option if the window is already opened as a dialog.
    
    Parameters:
    
    closeable - closeable
  - getHeightUnit
```
public SizeUnit getHeightUnit()
```
    Deprecated.
    
    Returns:
    
    units used in height property
  - setHeightUnit
```
public DialogOptions setHeightUnit(SizeUnit heightUnit)
```
    Deprecated.
    
    Sets the unit used for the height.
    
    Parameters:
    
    heightUnit - the unit used for the height
  - getHeight
```
public java.lang.Float getHeight()
```
    Deprecated.
    
    Returns:
    
    actual height if window opened as a dialog or if value is set from window controller
  - setHeight
```
@Deprecated
public DialogOptions setHeight(java.lang.Integer height)
```
    Deprecated. Use setHeight(Float) instead.
    
    Set height of a window if it will be opened as a dialog or change height at run time if the window is already opened as a dialog. If the heightUnit is set then its value will be used, SizeUnit.PIXELS otherwise.
    
    Parameters:
    
    height - the height value in the unit used for the height
  - setHeight
```
public DialogOptions setHeight(java.lang.Float height)
```
    Deprecated.
    
    Set height of a window if it will be opened as a dialog or change height at run time if the window is already opened as a dialog. If the heightUnit is set then its value will be used, SizeUnit.PIXELS otherwise.
    
    Parameters:
    
    height - the height value in the unit used for the height
  - setHeight
```
public DialogOptions setHeight(java.lang.String height)
```
    Deprecated.
    
    Sets the height of a window if it will be opened as a dialog using String presentation or change height at run time if the window is already opened as a dialog.
    Null, empty or 'AUTO' string will produce undefined height and set units to pixels.
    
    Parameters:
    
    height - height string representation
  - setHeight
```
protected DialogOptions setHeight(java.lang.Float height,
                                  SizeUnit unit)
```
    Deprecated.
  - getModal
```
public java.lang.Boolean getModal()
```
    Deprecated.
    
    Returns:
    
    true if a window is opened as a dialog and the window is modal or if set to true from the window controller
  - setModal
```
public DialogOptions setModal(java.lang.Boolean modal)
```
    Deprecated.
    
    Set modal option if a window will be opened as a dialog or change modal option if the window is already opened as a dialog.
    
    Parameters:
    
    modal - modal
  - getResizable
```
public java.lang.Boolean getResizable()
```
    Deprecated.
    
    Returns:
    
    true if a window is opened as a dialog and the window is resizable or if set to true from the window controller
  - setResizable
```
public DialogOptions setResizable(java.lang.Boolean resizable)
```
    Deprecated.
    
    Set resizable option if a window will be opened as a dialog or change resizable option if the window is already opened as a dialog.
    
    Parameters:
    
    resizable - resizable
  - getWidthUnit
```
public SizeUnit getWidthUnit()
```
    Deprecated.
    
    Returns:
    
    units used in width property
  - setWidthUnit
```
public DialogOptions setWidthUnit(SizeUnit widthUnit)
```
    Deprecated.
    
    Sets the unit used for the width.
    
    Parameters:
    
    widthUnit - the unit used for the width
  - getWidth
```
public java.lang.Float getWidth()
```
    Deprecated.
    
    Returns:
    
    actual width if window opened as a dialog or if value is set from window controller
  - setWidth
```
@Deprecated
public DialogOptions setWidth(java.lang.Integer width)
```
    Deprecated. Use setWidth(Float) instead.
    
    Set width of a window if it will be opened as a dialog or change width at run time if the window is already opened as a dialog. If the widthUnit is set then its value will be used, SizeUnit.PIXELS otherwise.
    
    Parameters:
    
    width - the width value in the unit used for the height
  - setWidth
```
public DialogOptions setWidth(java.lang.Float width)
```
    Deprecated.
    
    Set width of a window if it will be opened as a dialog or change width at run time if the window is already opened as a dialog. If the widthUnit is set then its value will be used, SizeUnit.PIXELS otherwise.
    
    Parameters:
    
    width - the width value in the unit used for the height
  - setWidth
```
public DialogOptions setWidth(java.lang.String width)
```
    Deprecated.
    
    Sets the width of a window if it will be opened as a dialog using String presentation or change width at run time if the window is already opened as a dialog.
    Null, empty or 'AUTO' string will produce undefined width and set units to pixels.
    
    Parameters:
    
    width - width string representation
  - setWidth
```
protected DialogOptions setWidth(java.lang.Float width,
                                 SizeUnit unit)
```
    Deprecated.
  - getForceDialog
```
public java.lang.Boolean getForceDialog()
```
    Deprecated.
    
    Returns:
    
    true if set to true from a window controller
  - setForceDialog
```
@Deprecated
public DialogOptions setForceDialog(java.lang.Boolean forceDialog)
```
    Deprecated. Does not affect window open mode anymore. Use DialogMode.forceDialog() on controller class or set forceDialog attribute in XML descriptor.
    
    Force a window manager to open a window as a dialog. Can be set from AbstractWindow.init() method before the window is shown.
    
    Parameters:
    
    forceDialog - force dialog option
  - setWidthAuto
```
public DialogOptions setWidthAuto()
```
    Deprecated.
    
    Set width of a window to AUTO if it will be opened as a dialog or change width at run time if the window is already opened as a dialog.
  - setHeightAuto
```
public DialogOptions setHeightAuto()
```
    Deprecated.
    
    Set height of a window to AUTO if it will be opened as a dialog or change height at run time if the window is already opened as a dialog.
  - center
```
public DialogOptions center()
```
    Deprecated.
    
    Center window only if it is already opened
  - setCloseOnClickOutside
```
public DialogOptions setCloseOnClickOutside(java.lang.Boolean closeOnClickOutside)
```
    Deprecated.
    
    Set closeOnClickOutside to true if a window should be closed by click on outside window area. It works when a window has a modal mode.
  - getCloseOnClickOutside
```
public java.lang.Boolean getCloseOnClickOutside()
```
    Deprecated.
    
    Returns:
    
    true if a window can be closed by click on outside window area
  - setMaximized
```
public DialogOptions setMaximized(java.lang.Boolean maximized)
```
    Deprecated.
    
    Set maximized to true if a window should be maximized across the screen.
  - getMaximized
```
public java.lang.Boolean getMaximized()
```
    Deprecated.
    
    Returns:
    
    true if a window is maximized across the screen.
  - getPositionX
```
public java.lang.Integer getPositionX()
```
    Deprecated.
    
    Returns:
    
    x position of top-left corner of dialog window
  - setPositionX
```
public DialogOptions setPositionX(java.lang.Integer positionX)
```
    Deprecated.
    
    Set the distance of Window left border in pixels from left border of the containing (main window).
    
    Parameters:
    
    positionX - x position
  - getPositionY
```
public java.lang.Integer getPositionY()
```
    Deprecated.
    
    Returns:
    
    y position of top-left corner of dialog window
  - setPositionY
```
public DialogOptions setPositionY(java.lang.Integer positionY)
```
    Deprecated.
    
    Sets the distance of Window left border in pixels from top border of the containing (main window).
    
    Parameters:
    
    positionY - y position

Class DialogOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DialogOptions

Method Detail

getCloseable

setCloseable

getHeightUnit

setHeightUnit

getHeight

setHeight

setHeight

setHeight

setHeight

getModal

setModal

getResizable

setResizable

getWidthUnit

setWidthUnit

getWidth

setWidth

setWidth

setWidth

setWidth

getForceDialog

setForceDialog

setWidthAuto

setHeightAuto

center

setCloseOnClickOutside

getCloseOnClickOutside

setMaximized

getMaximized

getPositionX

setPositionX

getPositionY

setPositionY