com.guiseframework.model
Enum View

java.lang.Object
  extended by java.lang.Enum<View>
      extended by com.guiseframework.model.View
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<View>

public enum View
extends java.lang.Enum<View>

Represents a view or aspect of data.

Author:
Garret Wilson

Enum Constant Summary
LIST
          The view in which a list of items is shown.
SEQUENCE
          The view in which a sequence of items is shown, perhaps as a card deck.
THUMBNAILS
          The view in which the data is shown as a series of small images.
TREE
          The view in which the data is shown in a tree structure.
WYSIWYG
          The view in which the data is shown as it would be in its final form.
 
Method Summary
 java.net.URI getGlyph()
           
 java.lang.String getLabel()
           
static java.net.URI getNoGlyph()
           
static java.lang.String getNoLabel()
           
 java.lang.String toString()
          Returns a string representation of the view.
static View valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static View[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

LIST

public static final View LIST
The view in which a list of items is shown.


SEQUENCE

public static final View SEQUENCE
The view in which a sequence of items is shown, perhaps as a card deck.


THUMBNAILS

public static final View THUMBNAILS
The view in which the data is shown as a series of small images.


TREE

public static final View TREE
The view in which the data is shown in a tree structure.


WYSIWYG

public static final View WYSIWYG
The view in which the data is shown as it would be in its final form.

Method Detail

values

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

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

valueOf

public static View 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

getNoLabel

public static java.lang.String getNoLabel()
Returns:
A resource reference representing a label for no view.

getLabel

public java.lang.String getLabel()
Returns:
The resource reference for the view label.

getNoGlyph

public static java.net.URI getNoGlyph()
Returns:
A resource reference representing a glyph for no view.

getGlyph

public java.net.URI getGlyph()
Returns:
The resource reference for the view glyph.

toString

public java.lang.String toString()
Returns a string representation of the view. This implementation delegates to getLabel().

Overrides:
toString in class java.lang.Enum<View>
Returns:
A string representation of the object.


Copyright © 2005-2010 GlobalMentor, Inc. All Rights Reserved.