org.odftoolkit.odfdom.doc.presentation
Enum OdfSlide.SlideLayout

java.lang.Object
  extended by java.lang.Enum<OdfSlide.SlideLayout>
      extended by org.odftoolkit.odfdom.doc.presentation.OdfSlide.SlideLayout
All Implemented Interfaces:
Serializable, Comparable<OdfSlide.SlideLayout>
Enclosing class:
OdfSlide

public static enum OdfSlide.SlideLayout
extends Enum<OdfSlide.SlideLayout>

A slide layout is a slide with some predefine placeholder. we define some template layout as below: "blank" template is a slide without any filled element, "title_only" template is a slide with a title, "title_outline" template is a slide with a title and an outline block, "title_text" template is a slide with a title and a text block, "title_two_text_block" template is a slide with a title two text blocks.


Enum Constant Summary
BLANK
          Blank, a blank presentation
TITLE_ONLY
          Title_only, the presentation with title only
TITLE_OUTLINE
          Title_outline, the presentation with outline
TITLE_PLUS_2_TEXT_BLOCK
          title_two_text_block, the presentation with title and two text blocks
TITLE_PLUS_TEXT
          Title_text, the presentation with title and one text block
 
Method Summary
static OdfSlide.SlideLayout enumValueOf(String aString)
          Return a template slide type.
 String toString()
          Return the slide template type value.
static String toString(OdfSlide.SlideLayout aEnum)
          Return the name of the template slide type.
static OdfSlide.SlideLayout valueOf(String name)
          Returns the enum constant of this type with the specified name.
static OdfSlide.SlideLayout[] 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

BLANK

public static final OdfSlide.SlideLayout BLANK
Blank, a blank presentation


TITLE_ONLY

public static final OdfSlide.SlideLayout TITLE_ONLY
Title_only, the presentation with title only


TITLE_OUTLINE

public static final OdfSlide.SlideLayout TITLE_OUTLINE
Title_outline, the presentation with outline


TITLE_PLUS_TEXT

public static final OdfSlide.SlideLayout TITLE_PLUS_TEXT
Title_text, the presentation with title and one text block


TITLE_PLUS_2_TEXT_BLOCK

public static final OdfSlide.SlideLayout TITLE_PLUS_2_TEXT_BLOCK
title_two_text_block, the presentation with title and two text blocks

Method Detail

values

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

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

valueOf

public static OdfSlide.SlideLayout 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

toString

public String toString()
Return the slide template type value.

Overrides:
toString in class Enum<OdfSlide.SlideLayout>
Returns:
the template type value

toString

public static String toString(OdfSlide.SlideLayout aEnum)
Return the name of the template slide type.

Parameters:
aEnum - a SlideLayout
Returns:
the name of slide template type

enumValueOf

public static OdfSlide.SlideLayout enumValueOf(String aString)
Return a template slide type.

Parameters:
aString - the name of the slide template type
Returns:
a SlideLayout


Copyright © 2008-2011 The Apache Software Foundation. All Rights Reserved.