IPERatioCustomize (Media Handler 1.10.0 API)

java.lang.Object
- java.lang.Enum<IPERatioCustomize>
- - io.wcm.handler.media.markup.IPERatioCustomize

All Implemented Interfaces:

Serializable, Comparable<IPERatioCustomize>
```
@ProviderType
public enum IPERatioCustomize
extends Enum<IPERatioCustomize>
```
Controls whether the list of IPE cropping ratios is customized by the media handler to match with the ratios of the selected media formats. (If at all and in which WCM mode the ratio customization takes place depends on the implementation of the markup builder and the media source.)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ALWAYS`	Always set customized cropping ratios, overwriting any existing ones.
`AUTO`	Set customized cropping ratios only when non are defined for the component.
`NEVER`	Never set customized cropping ratios.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static IPERatioCustomize`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static IPERatioCustomize[]`	`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
  - AUTO
```
public static final IPERatioCustomize AUTO
```
    Set customized cropping ratios only when non are defined for the component.
  - NEVER
```
public static final IPERatioCustomize NEVER
```
    Never set customized cropping ratios.
  - ALWAYS
```
public static final IPERatioCustomize ALWAYS
```
    Always set customized cropping ratios, overwriting any existing ones.
- Method Detail
  - values
```
public static IPERatioCustomize[] 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 (IPERatioCustomize c : IPERatioCustomize.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static IPERatioCustomize 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