org.odftoolkit.simple.presentation
Enum Slide.SlideLayout

java.lang.Object
  java.lang.Enum<Slide.SlideLayout>
      org.odftoolkit.simple.presentation.Slide.SlideLayout

All Implemented Interfaces:

Serializable, Comparable<Slide.SlideLayout>

Enclosing class:

Slide

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

A slide layout is a slide with some predefine place holder. 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 only.
• "TITLE_SUBTITLE" template is a slide with a title and a subtitle.
• "TITLE_OUTLINE" template is a slide with a title and an outline block.
• "TITLE_PLUS_TEXT" template is a slide with a title and a text block.
• "TITLE_PLUS_CHART" template is a slide with a title and a chart block.
• "TITLE_PLUS_2_TEXT_BLOCK" template is a slide with a title and two text blocks.
• "TITLE_PLUS_2_CHART" template is a slide with a title and two chart blocks.
• "TITLE_LEFT_CHART_RIGHT_OUTLINE" template is a slide with a title, a chart block on the left and an outline block on the right.
• "TITLE_PLUS_3_OBJECT" template is a slide with a title, an outline block and two chart blocks.
• "TITLE_PLUS_4_OBJECT" template is a slide with a title, an outline block and three chart blocks.

Enum Constant Summary

BLANK
Blank, a blank presentation

TITLE_LEFT_CHART_RIGHT_OUTLINE
title_three_objects, the presentation with title, chart and outline blocks.

TITLE_ONLY
Title_only, the presentation with title only

TITLE_OUTLINE
Title_outline, the presentation with outline

TITLE_PLUS_2_CHART
title_plus_two_chart, the presentation with title and two charts.

TITLE_PLUS_2_TEXT_BLOCK
title_two_text_block, the presentation with title and two text blocks

TITLE_PLUS_3_OBJECT
title_three_object, the presentation with title and three object blocks.

TITLE_PLUS_4_OBJECT
title_four_object, the presentation with title and four object blocks.

TITLE_PLUS_CHART
title_plus_chart, the presentation with title and chart.

TITLE_PLUS_TEXT
Title_text, the presentation with title and one text block

TITLE_SUBTITLE
title_subtitle, the presentation with title and subtitle.

Method Summary

abstract void	apply(DrawPageElement page) Applies this layout on a slide page.
static Slide.SlideLayout	enumValueOf(String aString) Return a template slide type.
String	toString() Return the slide template type value.
static String	toString(Slide.SlideLayout aEnum) Return the name of the template slide type.
static Slide.SlideLayout	valueOf(String name) Returns the enum constant of this type with the specified name.
static Slide.SlideLayout[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BLANK

public static final Slide.SlideLayout BLANK

Blank, a blank presentation

TITLE_ONLY

public static final Slide.SlideLayout TITLE_ONLY

Title_only, the presentation with title only

TITLE_SUBTITLE

public static final Slide.SlideLayout TITLE_SUBTITLE

title_subtitle, the presentation with title and subtitle.

TITLE_OUTLINE

public static final Slide.SlideLayout TITLE_OUTLINE

Title_outline, the presentation with outline

TITLE_PLUS_TEXT

public static final Slide.SlideLayout TITLE_PLUS_TEXT

Title_text, the presentation with title and one text block

TITLE_PLUS_2_TEXT_BLOCK

public static final Slide.SlideLayout TITLE_PLUS_2_TEXT_BLOCK

title_two_text_block, the presentation with title and two text blocks

TITLE_LEFT_CHART_RIGHT_OUTLINE

public static final Slide.SlideLayout TITLE_LEFT_CHART_RIGHT_OUTLINE

title_three_objects, the presentation with title, chart and outline blocks.

TITLE_PLUS_CHART

public static final Slide.SlideLayout TITLE_PLUS_CHART

title_plus_chart, the presentation with title and chart.

TITLE_PLUS_2_CHART

public static final Slide.SlideLayout TITLE_PLUS_2_CHART

title_plus_two_chart, the presentation with title and two charts.

TITLE_PLUS_3_OBJECT

public static final Slide.SlideLayout TITLE_PLUS_3_OBJECT

title_three_object, the presentation with title and three object blocks.

TITLE_PLUS_4_OBJECT

public static final Slide.SlideLayout TITLE_PLUS_4_OBJECT

title_four_object, the presentation with title and four object blocks.

Method Detail

values

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

Returns:

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

valueOf

public static Slide.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

apply

public abstract void apply(DrawPageElement page)

Applies this layout on a slide page.

Parameters:

page - the slide element which this layout is applied on.

Since:

0.6

toString

public String toString()

Return the slide template type value.

Overrides:

toString in class Enum<Slide.SlideLayout>

Returns:

the template type value

toString

public static String toString(Slide.SlideLayout aEnum)

Return the name of the template slide type.

Parameters:

aEnum - a SlideLayout

Returns:

the name of slide template type

enumValueOf

public static Slide.SlideLayout enumValueOf(String aString)

Return a template slide type.

Parameters:

aString - the name of the slide template type

Returns:

a SlideLayout