org.alembik.util
Enum TranscodingUtils.NavigationBarAttr

java.lang.Object
  java.lang.Enum<TranscodingUtils.NavigationBarAttr>
      org.alembik.util.TranscodingUtils.NavigationBarAttr

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TranscodingUtils.NavigationBarAttr>

Enclosing class:

TranscodingUtils

public static enum TranscodingUtils.NavigationBarAttr
extends java.lang.Enum<TranscodingUtils.NavigationBarAttr>

The NavigBar transformation attributes.

The specification of any of these attributes overrides the default configuration of the navigation panel.

See Also:

TranscodingUtils.setNavigationBarAttrs(TranscodingJob, Map), TranscodingUtils.getNavigationBarAttrs(TranscodingJob)

Enum Constant Summary

BACK_LABEL
The desired label for the "back" button/link.

CLOSE_LABEL
The desired label for the "close" button/link.

GO_TO_LABEL
The desired label for the "go to menu index" button/link.

HOME_LABEL
The desired label for the "home" button/link.

HOME_URL
The desired home page location.

PAGE_LABEL
The desired "page" label.

PAGING_BG_COLOR
The desired background color for the navigation panel.

PAGING_FONT_COLOR
The desired font color in the navigation panel.

PAGING_LINK_COLOR
The desired link color in the navigation panel.

Method Summary

static TranscodingUtils.NavigationBarAttr	fromName(java.lang.String name) Gets the enum instance of the given attribute name.
java.lang.String	getName() Returns the name of the attribute.
static TranscodingUtils.NavigationBarAttr	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TranscodingUtils.NavigationBarAttr[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BACK_LABEL

public static final TranscodingUtils.NavigationBarAttr BACK_LABEL

The desired label for the "back" button/link.

GO_TO_LABEL

public static final TranscodingUtils.NavigationBarAttr GO_TO_LABEL

The desired label for the "go to menu index" button/link.

PAGE_LABEL

public static final TranscodingUtils.NavigationBarAttr PAGE_LABEL

The desired "page" label.

HOME_LABEL

public static final TranscodingUtils.NavigationBarAttr HOME_LABEL

The desired label for the "home" button/link.

HOME_URL

public static final TranscodingUtils.NavigationBarAttr HOME_URL

The desired home page location.

PAGING_BG_COLOR

public static final TranscodingUtils.NavigationBarAttr PAGING_BG_COLOR

The desired background color for the navigation panel. It is an RGB number in HEX format, e.g. #FFFFFF.

PAGING_FONT_COLOR

public static final TranscodingUtils.NavigationBarAttr PAGING_FONT_COLOR

The desired font color in the navigation panel. It is an RGB number in HEX format, e.g. #FFFFFF.

PAGING_LINK_COLOR

public static final TranscodingUtils.NavigationBarAttr PAGING_LINK_COLOR

The desired link color in the navigation panel. It is an RGB number in HEX format, e.g. #FFFFFF.

CLOSE_LABEL

public static final TranscodingUtils.NavigationBarAttr CLOSE_LABEL

The desired label for the "close" button/link.

Method Detail

values

public static final TranscodingUtils.NavigationBarAttr[] values()

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

for(TranscodingUtils.NavigationBarAttr c : TranscodingUtils.NavigationBarAttr.values())
        System.out.println(c);

Returns:

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

valueOf

public static TranscodingUtils.NavigationBarAttr valueOf(java.lang.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:

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

getName

public java.lang.String getName()

Returns the name of the attribute.

Returns:

name value

fromName

public static TranscodingUtils.NavigationBarAttr fromName(java.lang.String name)

Gets the enum instance of the given attribute name.

Parameters:

name - the attribute name

Returns:

enum instance.