blackboard.data.content
Enum Lesson.HierarchyDisplay

java.lang.Object
  extended by java.lang.Enum<Lesson.HierarchyDisplay>
      extended by blackboard.data.content.Lesson.HierarchyDisplay
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Lesson.HierarchyDisplay>
Enclosing class:
Lesson

public static enum Lesson.HierarchyDisplay
extends java.lang.Enum<Lesson.HierarchyDisplay>

The hierarchy display of a lesson (learning unit/module) can be customized to render in a number of different ways.


Enum Constant Summary
Letter
          Items will display proceeded by letters appropriate to level (A, A.a, A.b, etc.)
Mixed
          Item will display using a mix of Roman numerals, letters, and numbers (I, I.a, I.a.1, etc.)
None
          No formatting will be used.
Number
          Items will display proceeded by numbers appropriate to level (1, 1.1, 1.2, etc.)
RomanNumeral
          Items will display proceeded by Roman numerals appropriate to level (I, I.i, I.ii, etc.)
 
Method Summary
static Lesson.HierarchyDisplay getDefault()
          Returns the default display used in the application
 java.lang.String getName()
          Simple wrapper for name() that provides JSTL compliance.
 java.lang.String render(int[] counters)
          render
static Lesson.HierarchyDisplay valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Lesson.HierarchyDisplay[] 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

None

public static final Lesson.HierarchyDisplay None
No formatting will be used. This is the default.


Letter

public static final Lesson.HierarchyDisplay Letter
Items will display proceeded by letters appropriate to level (A, A.a, A.b, etc.)


Mixed

public static final Lesson.HierarchyDisplay Mixed
Item will display using a mix of Roman numerals, letters, and numbers (I, I.a, I.a.1, etc.)


Number

public static final Lesson.HierarchyDisplay Number
Items will display proceeded by numbers appropriate to level (1, 1.1, 1.2, etc.)


RomanNumeral

public static final Lesson.HierarchyDisplay RomanNumeral
Items will display proceeded by Roman numerals appropriate to level (I, I.i, I.ii, etc.)

Method Detail

values

public static Lesson.HierarchyDisplay[] 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 (Lesson.HierarchyDisplay c : Lesson.HierarchyDisplay.values())
    System.out.println(c);

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

valueOf

public static Lesson.HierarchyDisplay 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
java.lang.NullPointerException - if the argument is null

getDefault

public static Lesson.HierarchyDisplay getDefault()
Returns the default display used in the application


getName

public java.lang.String getName()
Simple wrapper for name() that provides JSTL compliance.

See Also:
Enum.name()

render

public java.lang.String render(int[] counters)
render



Copyright © 2012 Blackboard, Inc. All Rights Reserved.