com.haulmont.cuba.gui

Enum WindowParams

java.lang.Object

java.lang.Enum<WindowParams>

com.haulmont.cuba.gui.WindowParams

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WindowParams>

Deprecated.

replace window parameters usage with explicit API calls on a screen controller

@Deprecated
public enum WindowParams
extends java.lang.Enum<WindowParams>

Describes special window parameters that are set by system mechanisms such as WindowManager. Some of the parameters are intended for use by application code, others affect low-level window opening behaviour.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAPTION Deprecated. Window caption that can be set by controller in its init method.
DESCRIPTION Deprecated. Window description that can be set by controller in its init method.
DISABLE_APPLY_SETTINGS Deprecated. Disables window settings applying after showing a window.
DISABLE_AUTO_REFRESH Deprecated. Prevents datasources from automatic refresh caused by visual components.
DISABLE_RESUME_SUSPENDED Deprecated. Disables suspendable datasources resuming after showing a window.
FOLDER_ID Deprecated. Folder's UUID if the screen is opening from FoldersPane.
ITEM Deprecated. Entity instance which is passed to an editor's controller init method from WindowManager.
MULTI_SELECT Deprecated. If this parameter is set, a lookup screen can set up its lookup component (usually Table) for multi-selection.

Method Summary

Modifier and Type	Method and Description
<T> T	get(FrameContext context) Deprecated. Get value from the WindowContext.
<T> T	get(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Get value from the parameters map.
boolean	getBool(FrameContext context) Deprecated. Get boolean value from the WindowContext.
Entity	getEntity(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Get Entity value from the parameters map.
java.lang.String	getString(FrameContext context) Deprecated. Get string value from the WindowContext.
java.lang.String	getString(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Get string value from the parameters map.
java.util.UUID	getUuid(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Get UUID value from the parameters map.
void	set(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.Object value) Deprecated. Set value in the parameters map.
static WindowParams	valueOf(java.lang.String name) Deprecated. Returns the enum constant of this type with the specified name.
static WindowParams[]	values() Deprecated. Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ITEM

public static final WindowParams ITEM

Deprecated.

Entity instance which is passed to an editor's controller init method from WindowManager.

FOLDER_ID

public static final WindowParams FOLDER_ID

Deprecated.

Folder's UUID if the screen is opening from FoldersPane.

CAPTION

public static final WindowParams CAPTION

Deprecated.

Window caption that can be set by controller in its init method.

DESCRIPTION

public static final WindowParams DESCRIPTION

Deprecated.

Window description that can be set by controller in its init method. Description is shown as window tab tooltip.

MULTI_SELECT

public static final WindowParams MULTI_SELECT

Deprecated.

If this parameter is set, a lookup screen can set up its lookup component (usually Table) for multi-selection.

DISABLE_AUTO_REFRESH

public static final WindowParams DISABLE_AUTO_REFRESH

Deprecated.

Prevents datasources from automatic refresh caused by visual components.

DISABLE_APPLY_SETTINGS

public static final WindowParams DISABLE_APPLY_SETTINGS

Deprecated.

Disables window settings applying after showing a window.

DISABLE_RESUME_SUSPENDED

public static final WindowParams DISABLE_RESUME_SUSPENDED

Deprecated.

Disables suspendable datasources resuming after showing a window.

Method Detail

values

public static WindowParams[] values()

Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WindowParams c : WindowParams.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WindowParams valueOf(java.lang.String name)

Deprecated.

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getBool

public boolean getBool(@Nullable
                       FrameContext context)

Deprecated.

Get boolean value from the WindowContext.

Parameters:

context - window context

Returns:

parameter value

getString

@Nullable
public java.lang.String getString(@Nullable
                                            FrameContext context)

Deprecated.

Get string value from the WindowContext.

Parameters:

context - window context

Returns:

parameter value

getString

public java.lang.String getString(java.util.Map<java.lang.String,java.lang.Object> params)

Deprecated.

Get string value from the parameters map.

Parameters:

params - parameters map

Returns:

parameter value

getEntity

public Entity getEntity(java.util.Map<java.lang.String,java.lang.Object> params)

Deprecated.

Get Entity value from the parameters map.

Parameters:

params - parameters map

Returns:

parameter value

getUuid

public java.util.UUID getUuid(java.util.Map<java.lang.String,java.lang.Object> params)

Deprecated.

Get UUID value from the parameters map.

Parameters:

params - parameters map

Returns:

parameter value

get

@Nullable
public <T> T get(@Nullable
                           FrameContext context)

Deprecated.

Get value from the WindowContext.

Parameters:

context - window context

Returns:

parameter value

get

public <T> T get(java.util.Map<java.lang.String,java.lang.Object> params)

Deprecated.

Get value from the parameters map.

Parameters:

params - parameters map

Returns:

parameter value

set

public void set(java.util.Map<java.lang.String,java.lang.Object> params,
                java.lang.Object value)

Deprecated.

Set value in the parameters map.

Parameters:

params - window parameters map

value - parameter value