lumis.portal.serviceinterface

Enum OpenRuntimeInterfaceBehavior

java.lang.Object

java.lang.Enum<OpenRuntimeInterfaceBehavior>

lumis.portal.serviceinterface.OpenRuntimeInterfaceBehavior

All Implemented Interfaces:

Serializable, Comparable<OpenRuntimeInterfaceBehavior>

public enum OpenRuntimeInterfaceBehavior
extends Enum<OpenRuntimeInterfaceBehavior>

Indicates the behavior to be applied when a runtime interface is to be opened.

Since:

7.0.0

Version:

$Revision: 15055 $ $Date: 2012-11-29 20:48:37 +0000 (Thu, 29 Nov 2012) $

Enum Constant Summary

Enum Constants

Enum Constant and Description
LIGHTBOX Indicates that the runtime interface will be opened in a lightbox.
POPUP Indicates that the runtime interface will be opened in a popup window.
REPLACE Indicates that the runtime interface will replace the opener interface and be shown in the same page.

Method Summary

Modifier and Type	Method and Description
static OpenRuntimeInterfaceBehavior	from(PageWebResource pageWebResource, boolean keepParentActive) Returns the OpenRuntimeInterfaceBehavior for the given page.
static OpenRuntimeInterfaceBehavior	from(String value, boolean withParentActive) Returns the OpenRuntimeInterfaceBehavior accordingly to the given value.
static OpenRuntimeInterfaceBehavior	from(String value, boolean useDefault, boolean withParentActive) Returns the OpenRuntimeInterfaceBehavior accordingly to the given value.
static OpenRuntimeInterfaceBehavior	getDefaultBehavior(boolean keepParentActive) Returns the default behavior.
static OpenRuntimeInterfaceBehavior	valueOf(String name) Returns the enum constant of this type with the specified name.
static OpenRuntimeInterfaceBehavior[]	values() 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

REPLACE

public static final OpenRuntimeInterfaceBehavior REPLACE

Indicates that the runtime interface will replace the opener interface and be shown in the same page.

Since:

7.0.0

POPUP

public static final OpenRuntimeInterfaceBehavior POPUP

Indicates that the runtime interface will be opened in a popup window.

Since:

7.0.0

LIGHTBOX

public static final OpenRuntimeInterfaceBehavior LIGHTBOX

Indicates that the runtime interface will be opened in a lightbox.

Since:

7.0.0

Method Detail

values

public static OpenRuntimeInterfaceBehavior[] values()

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 (OpenRuntimeInterfaceBehavior c : OpenRuntimeInterfaceBehavior.values())
    System.out.println(c);

Returns:

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

valueOf

public static OpenRuntimeInterfaceBehavior valueOf(String name)

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:

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

NullPointerException - if the argument is null

from

public static OpenRuntimeInterfaceBehavior from(String value,
                                                boolean withParentActive)

Returns the OpenRuntimeInterfaceBehavior accordingly to the given value. When the value is null or is an empty string, the returned value is calculated in getDefaultBehavior(boolean).
This method should be used preferentially to valueOf(String).

Parameters:

value - the value of the OpenRuntimeInterfaceBehavior being requested.

withParentActive - indicates whether a parent window is required.

Returns:

the OpenRuntimeInterfaceBehavior accordingly to the given value.

Since:

7.0.0

from

public static OpenRuntimeInterfaceBehavior from(String value,
                                                boolean useDefault,
                                                boolean withParentActive)

Returns the OpenRuntimeInterfaceBehavior accordingly to the given value. When the value is null or is an empty string and the parameter useDefault is true, the returned value is calculated in getDefaultBehavior(boolean).
This method should be used preferentially to valueOf(String).

Parameters:

value - the value of the OpenRuntimeInterfaceBehavior being requested.

useDefault - indicates whether the default value should be used if the given value is null or empty.

withParentActive - indicates whether a parent window is required.

Returns:

the OpenRuntimeInterfaceBehavior accordingly to the given value.

Since:

7.0.0

from

public static OpenRuntimeInterfaceBehavior from(PageWebResource pageWebResource,
                                                boolean keepParentActive)
                                         throws PortalException

Returns the OpenRuntimeInterfaceBehavior for the given page.

Parameters:

pageWebResource - the page web resource.

keepParentActive - indicates whether the parent should be kept active.

Returns:

the OpenRuntimeInterfaceBehavior for the given page.

Throws:

PortalException

Since:

7.0.0

getDefaultBehavior

public static OpenRuntimeInterfaceBehavior getDefaultBehavior(boolean keepParentActive)

Returns the default behavior. If the parameter keepParentActive is true returns LIGHTBOX. Returns REPLACE otherwise.

Parameters:

keepParentActive - indicates whether the parent should be kept active.

Returns:

the default behavior.

Since:

7.0.0