Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## application.workbooks.workbook.presentations.presentation
Class SlideShowSettings

    java.lang.Object
      application.workbooks.workbook.presentations.presentation.SlideShowSettings

public class SlideShowSettings
extends java.lang.Object

该类定义了幻灯片放映设置。

Method Summary
`java.lang.String` | `getCustomListByName()` 得到设置的自定义放映列表名。
`java.awt.Color` | `getPenColor()` 得到画笔颜色。
`int` | `getPenWithScheme()` 得到画笔颜色相关的配色方案索引。
`int` | `getPresentOrderType()` 得到幻灯片播放列表类型。
`int` | `getPresentType()` 得到幻灯片放映方式。
`java.awt.Color` | `getScreenColor()` 得到屏幕颜色。
`int` | `getScreenWithScheme()` 得到屏幕颜色相关的配色方案索引。
`int` | `getShowEnd()` 得到放映的最后一张幻灯片编号。
`int` | `getShowStart()` 得到放映的第一张幻灯片编号。
`boolean` | `isLoopUntilEsc()` 判断是否循环放映幻灯片，直到按下Esc键终止幻灯片放映。
`boolean` | `isManualShow()` 是否人工放映幻灯片。
`boolean` | `isShowWithAnimation()` 判断是否放映时添加了动画效果。
`boolean` | `isShowWithNarration()` 判断观看放映时，是否播放声音旁白。
`void` | `setCustomListByName(java.lang.String customShowName)` 根据列表索引设置自定义放映列表。
`void` | `setLoopUntilEsc(boolean loop)` 设置是否循环放映幻灯片，直到按下Esc键终止幻灯片放映。
`void` | `setManualShow(int mode)` 设置是否人工放映幻灯片。
`void` | `setPenColor(int penColorRed, int penColorGreen, int penColorBlue)` 设置画笔颜色。
`void` | `setPenWithScheme(int penColorIndex)` 设置与画笔颜色相关的配色方案索引。
`void` | `setPresentOrderType(int orderType)` 设置幻灯片播放列表类型。
`void` | `setPresentType(int presentType)` 设置幻灯片放映方式。
`void` | `setScreenColor(int screenColorRed, int screenColorGreen, int screenColorBlue)` 设置屏幕颜色。
`void` | `setScreenWithScheme(int screenColorIndex)` 设置与屏幕颜色相关的配色方案索引。
`void` | `setShowWithAnimation(boolean animation)` 放映时添加动画效果。
`void` | `setShowWithNarration(boolean narration)` 设置观看放映时，是否播放声音旁白。
`void` | `setStartEnd(int startSlide, int endSlide)` 当列表类型为播放某个范围内的幻灯片时，设置放映第一张和放映的最后一张幻灯片。

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### getCustomListByName

    public java.lang.String getCustomListByName()

  得到设置的自定义放映列表名。

  Returns:
    设置的自定义放映列表名

    例子:

         System.out.println(Presentations.getActivePresentation().getSlideShowSetting()
         .getCustomListByName());

  See Also:
    `setCustomListByName(String customShowName)`

### getPenColor

    public java.awt.Color getPenColor()

  得到画笔颜色。

  Returns:
    画笔颜色

    例子:

          System.out.println(Presentations.getActivePresentation().getSlideShowSetting()
          .getPenColor());

  See Also:
    `setPenColor(int penColorRed,int penColorGreen,int penColorBlue)`

### getPenWithScheme

    public int getPenWithScheme()

  得到画笔颜色相关的配色方案索引。

  Returns:
    画笔颜色相关的配色方案索引，为整型数值

    例子:

          System.out.println(Presentations.getActivePresentation().getSlideShowSetting()
          .getPenWithScheme());

  See Also:
    `setPenWithScheme(int penColorIndex)`

### getPresentOrderType

    public int getPresentOrderType()

  得到幻灯片播放列表类型。

  Returns:
    幻灯片列表类型，为整型数值

    0表示播放所有幻灯片；

    1表示播放某个范围内的幻灯片；

    2表示播放自定义列表里的幻灯片

    例子:

         System.out.println( Presentations.getActivePresentation().getSlideShowSetting().getPresentOrderType());

  See Also:
    `setPresentOrderType(int orderType)`

### getPresentType

    public int getPresentType()

  得到幻灯片放映方式。

  Returns:
    幻灯片放映方式，为整型数值

    0，表示人工放映；

    1，表示自动放映

    例子:

          System.out.println(Presentations.getActivePresentation().getSlideShowSetting().getPresentType());

  See Also:
    `setPresentType(int presentType)`

### getScreenColor

    public java.awt.Color getScreenColor()

  得到屏幕颜色。

  Returns:
    屏幕颜色

    例子:

          System.out.println(Presentations.getActivePresentation().getSlideShowSetting()
          .getScreenColor());

  See Also:
    `setScreenColor(int screenColorRed,int screenColorGreen,int screenColorBlue)`

### getScreenWithScheme

    public int getScreenWithScheme()

  得到屏幕颜色相关的配色方案索引。

  Returns:
    屏幕颜色相关的配色方案索引，为整型数值

    例子:

          System.out.println(Presentations.getActivePresentation().getSlideShowSetting()
          .getScreenWithScheme());

  See Also:
    `setScreenWithScheme(int screenColorIndex)`

### getShowEnd

    public int getShowEnd()

  得到放映的最后一张幻灯片编号。

  Returns:
    放映的最后一张幻灯片索引值

    例子:

          System.out.println( Presentations.getActivePresentation().getSlideShowSetting() .getShowEnd());

  See Also:
    `getShowStart()`, `setStartEnd(int startSlide,int endSlide)`

### getShowStart

    public int getShowStart()

  得到放映的第一张幻灯片编号。

  Returns:
    放映的第一张幻灯片索引值

    例子:

          System.out.println( Presentations.getActivePresentation().getSlideShowSetting().getShowStart());

  See Also:
    `setStartEnd(int startSlide,int endSlide)`, `getShowEnd()`

### isLoopUntilEsc

    public boolean isLoopUntilEsc()

  判断是否循环放映幻灯片，直到按下Esc键终止幻灯片放映。

  Returns:
    布尔型值，如果循环放映幻灯片，则返回true；如果不循环播放，则返回false

    例子:

          System.out.println(Presentations.getActivePresentation().getSlideShowSetting().isLoopUntilEsc());

  See Also:
    `setLoopUntilEsc(boolean loop)`

### isManualShow

    public boolean isManualShow()

  是否人工放映幻灯片。

  Returns:
    布尔型值，如果人工放映幻灯片，则返回true；如果自动反映，则返回false

    例子:

         System.out.println(Presentations.getActivePresentation().getSlideShowSetting()
         .isManualShow());

  See Also:
    `setManualShow(int mode)`

### isShowWithAnimation

    public boolean isShowWithAnimation()

  判断是否放映时添加了动画效果。

  Returns:
    布尔型值，如果放映时添加了动画效果，则返回true；否则，返回false

    例子:

         System.out.println( Presentations.getActivePresentation().getSlideShowSetting() . isShowWithAnimation());

  See Also:
    `setShowWithAnimation(boolean animation)`

### isShowWithNarration

    public boolean isShowWithNarration()

  判断观看放映时，是否播放声音旁白。

  Returns:
    布尔型值，如果播放声音旁白，则返回true；如果不播放声音旁白，则返回false

    例子:

         System.out.println( Presentations.getActivePresentation().getSlideShowSetting() .isShowWithNarration());

  See Also:
    `setShowWithNarration(boolean narration)`

### setCustomListByName

    public void setCustomListByName(java.lang.String customShowName)

  根据列表索引设置自定义放映列表。 如果索引列表有效的话，设置当前列表类型为自定义放映列表。

  Parameters:
    `customShowName` - 自定义放映列表名字

    例子:

          Presentations.getActivePresentation().getSlideShowSetting()
          .setCustomListByName("themarine");

  See Also:
    `getCustomListByName()`

### setLoopUntilEsc

    public void setLoopUntilEsc(boolean loop)

  设置是否循环放映幻灯片，直到按下Esc键终止幻灯片放映。

  Parameters:
    `loop` - 布尔型值，如果loop为true，循环放映幻灯片，直到按下Esc键终止幻灯片放映；如果loop为false,不循环播放

    例子:

         Presentations.getActivePresentation().getSlideShowSetting().setLoopUntilEsc(true);

  See Also:
    `isLoopUntilEsc()`

### setManualShow

    public void setManualShow(int mode)

  设置是否人工放映幻灯片。

  Parameters:
    `mode` - 是否人工放映的属性

    如果mode = 0，点击鼠标左键，将放映下一张幻灯片

    如果mode = 1，将会根据预先设置的时间自动放映幻灯片

    如果没有预先设置自动放映时间，则仍需应用人工方式

    例子:

         Presentations.getActivePresentation().getSlideShowSetting()
         .setManualShow(0);

  See Also:
    `isManualShow()`

### setPenColor

    public void setPenColor(int penColorRed,
                            int penColorGreen,
                            int penColorBlue)

  设置画笔颜色。

  Parameters:
    `penColorRed` - 画笔颜色中的红色成分
    `penColorGreen` - 画笔颜色中的绿色成分
    `penColorBlue` - 画笔颜色中的蓝色成分

    例子:

         Presentations.getActivePresentation().getSlideShowSetting()
         .setPenColor(255,255,255);

  See Also:
    `getPenColor()`

### setPenWithScheme

    public void setPenWithScheme(int penColorIndex)

  设置与画笔颜色相关的配色方案索引。

  Parameters:
    `penColorIndex` - 当前配色方案索引，为整型数值,其常量取值如下：

    SlideShowConstants.SCHEMEBACKGROUND = 0，表示背景色的配色方案；

    SlideShowConstants.SCHEMETITLETEXT = 1，表示标题文本的配色方案；

    SlideShowConstants.SCHEMETEXT = 2，表示正文的配色方案；

    SlideShowConstants.SCHEMELINES = 3，表示线条的配色方案；

    SlideShowConstants.SCHEMEFILL = 4，表示填充色的配色方案；

    SlideShowConstants.SCHEMESHADOW = 5，表示阴影的配色方案；

    SlideShowConstants.SCHEMEHYPERLINK = 6，表示超链接的配色方案；

    SlideShowConstants.SCHEMEFOLLOWEDHYPERLINK = 7，表示已访问过的超链接的配色方案

    例子:

          Presentations.getActivePresentation().getSlideShowSetting()
          .setPenWithScheme(SlideShowConstants.SCHEMEBACKGROUND);

  See Also:
    `getPenWithScheme()`, `SlideShowConstants`

### setPresentOrderType

    public void setPresentOrderType(int orderType)

  设置幻灯片播放列表类型。

  Parameters:
    `orderType` - 幻灯片播放列表类型，为整型数值 ,其常量取值如下：

    SlideShowConstants.PLAY_ALL_SLIDE = 0表示播放所有幻灯片；

    SlideShowConstants.PLAY_SOME_SLIDE = 1表示播放某个范围内的幻灯片；

    SlideShowConstants.PLAY_CUSTOMLIST_SLIDE = 2表示播放自定义列表里的幻灯片

    例子:

         Presentations.getActivePresentation().getSlideShowSetting().setPresentOrderType(2);

  See Also:
    `getPresentOrderType()`, `SlideShowConstants`

### setPresentType

    public void setPresentType(int presentType)

  设置幻灯片放映方式。

  Parameters:
    `presentType` - 幻灯片放映方式,其常量和相应的值如下：

         SlideShowConstants.MANUAL= 0，表示人工放映；
         SlideShowConstants.MANUAL= 1，表示自动放映

        例子:

         Presentations.getActivePresentation().getSlideShowSetting().setPresentType(SlideShowConstants.MANUAL);

  See Also:
    `getPresentType()`, `SlideShowConstants`

### setScreenColor

    public void setScreenColor(int screenColorRed,
                               int screenColorGreen,
                               int screenColorBlue)

  设置屏幕颜色。

  Parameters:
    `screenColorRed` - 屏幕颜色中的红色成分
    `screenColorGreen` - 屏幕颜色中的绿色成分
    `screenColorBlue` - 屏幕颜色中的蓝色成分

    例子:

         Presentations.getActivePresentation().getSlideShowSetting()
         .setScreenColor(255,255,0);

  See Also:
    `getScreenColor()`

### setScreenWithScheme

    public void setScreenWithScheme(int screenColorIndex)

  设置与屏幕颜色相关的配色方案索引。

  Parameters:
    `screenColorIndex` - 配色方案中的颜色索引，为整型数值其常量取值如下：

    SlideShowConstants.SCHEMEBACKGROUND = 0，表示背景色的配色方案；

    SlideShowConstants.SCHEMETITLETEXT = 1，表示标题文本的配色方案；

    SlideShowConstants.SCHEMETEXT = 2，表示正文的配色方案；

    SlideShowConstants.SCHEMELINES = 3，表示线条的配色方案；

    SlideShowConstants.SCHEMEFILL = 4，表示填充色的配色方案；

    SlideShowConstants.SCHEMESHADOW = 5，表示阴影的配色方案；

    SlideShowConstants.SCHEMEHYPERLINK = 6，表示超链接的配色方案；

    SlideShowConstants.SCHEMEFOLLOWEDHYPERLINK = 7，表示已访问过的超链接的配色方案

    例子:

          Presentations.getActivePresentation().getSlideShowSetting()
          .setScreenWithScheme(0);

  See Also:
    `getScreenWithScheme()`

### setShowWithAnimation

    public void setShowWithAnimation(boolean animation)

  放映时添加动画效果。

  Parameters:
    `animation` - 布尔型值，如为true，放映时添加动画效果；否则，放映时不添加动画效果

    例子:

         Presentations.getActivePresentation().getSlideShowSetting().setShowWithAnimation(false);

  See Also:
    `isShowWithAnimation()`

### setShowWithNarration

    public void setShowWithNarration(boolean narration)

  设置观看放映时，是否播放声音旁白。

  Parameters:
    `narration` - 布尔型值，如果narration为true，观看放映时，播放声音旁白；否则，放映时不播放任何声音旁白

    例子:

         Presentations.getActivePresentation().getSlideShowSetting() .setShowWithNarration(false);

  See Also:
    `isShowWithNarration()`

### setStartEnd

    public void setStartEnd(int startSlide,
                            int endSlide)

  当列表类型为播放某个范围内的幻灯片时，设置放映第一张和放映的最后一张幻灯片。

  Parameters:
    `startSlide` - 开始放映的那张幻灯片
    `endSlide` - 结束放映的那张幻灯片

    例子:

         Presentations.getActivePresentation().getSlideShowSetting() .setPresentOrderType(1);

         Presentations.getActivePresentation().getSlideShowSetting().setStartEnd(1,2);

  See Also:
    `getShowStart()`, `getShowEnd()`

Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

版权所有 2001-2004 无锡永中科技有限公司