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.worksheets
Class TimeSeries

    java.lang.Object
      application.workbooks.workbook.worksheets.TimeSeries

All Implemented Interfaces:
  TimeSeriesConstants

public class TimeSeries
extends java.lang.Object
implements TimeSeriesConstants

此类定义了创建时间序列应用的方法。

Field Summary

Fields inherited from interface application.constants.TimeSeriesConstants
`AUTO_DEFINE_MONTH, AUTO_DEFINE_QUARTER, AUTO_DEFINE_WEEK, AUTO_DEFINE_YEAR, AVERAGE, COUNT, CURRENCY, DAY, FIELD_FORMULA, FIRST, LAST, MAX, MIN, MONTH, NUMBER, NUMBER_CURRENCY, NUMBER_NUMBER, PERIOD, QUARTER, SUM, WEEK, YEAR`

Method Summary
`void` | `addConstant(java.lang.String constantName, java.lang.String constantValue)` 给当前时间序列应用增加常量。
`void` | `addField(java.lang.String fieldName, int dataType, int dataLength, int dataDecimal, int formatCategory, java.lang.String formatString, boolean required, java.lang.String fieldFormula, int functionType, java.lang.String validationFormula, java.lang.String defaultValue, int occurrenceFromIndex, int occurrenceToIndex, java.lang.String promptMessage, java.lang.String captionName, java.lang.String fieldPosition)`
增加一个字段。
`void` | `addField(java.lang.String fieldName, java.lang.String fieldFormula, java.lang.String validationFormula, java.lang.String defaultValue, java.lang.String promptMessage, java.lang.String fieldPosition)` 缺省设置增加字段。
`void` | `autoDefineSummaryPeriod(boolean isMonth, boolean isSingle, int autoType, boolean isAfterAll)` 自动定义加总期间。
`void` | `customizedDefineSummaryPeriod(java.lang.String summaryPeriodName, java.lang.String forColumn, java.lang.String sumAddress)` 自定义加总期间。
`void` | `defineBasePeriod(int basePeriodType, int periodNumber, int year, int month, int day, int formatIndex)` 定义基本期间。
`void` | `deleteConstant(java.lang.String constantName)` 删除当前时间序列应用常量。
`void` | `deleteField(java.lang.String fieldName)` 删除字段。
`void` | `link(boolean isWholeTS)` 公式链接。
`void` | `modifyBasePeriod(int newPeriodNumber, int year, int month, int day, int formatIndex)` 修改基本期间。
`void` | `modifyConstant(java.lang.String constantName, java.lang.String constantValue)` 修改当前时间序列应用常量。
`void` | `modifyField(java.lang.String oldName, java.lang.String newName, int dataType, int dataLength, int dataDecimal, int formatCategory, java.lang.String formatString, boolean required, java.lang.String fieldFormula, int functionType, java.lang.String validationFormula, java.lang.String defaultValue, int occurrenceFromIndex, int occurrenceToIndex, java.lang.String promptMessage, java.lang.String captionName, java.lang.String fieldPosition)`
修改一个字段。
`void` | `openTemplate(java.lang.String templateName)` 打开时间序列模板。
`void` | `saveAsTemplate(java.lang.String templateName)` 将当前时间序列应用存为模板。
`void` | `unlink(boolean isWholeTS)` 断开公式链接。
`void` | `validate()` 校验数据有效性。

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

Method Detail

### addConstant

    public void addConstant(java.lang.String constantName,
                            java.lang.String constantValue)

  给当前时间序列应用增加常量。

  Parameters:
    `constantName` - 常量名称
    `constantValue` - 常量值

### addField

    public void addField(java.lang.String fieldName,
                         int dataType,
                         int dataLength,
                         int dataDecimal,
                         int formatCategory,
                         java.lang.String formatString,
                         boolean required,
                         java.lang.String fieldFormula,
                         int functionType,
                         java.lang.String validationFormula,
                         java.lang.String defaultValue,
                         int occurrenceFromIndex,
                         int occurrenceToIndex,
                         java.lang.String promptMessage,
                         java.lang.String captionName,
                         java.lang.String fieldPosition)

  增加一个字段。

  Parameters:
    `fieldName` - 字段名
    `dataType` - 字段类型：NUMBER-表示数字，CURRENCY-表示货币
    `dataLength` - 字段长度
    `dataDecimal` - 小数点位数
    `formatCategory` - 格式化类别: NUMBER_NUMBER-表示数字； NUMBER_CURRENCY-表示货币
    `formatString` - 格式化后的字串样式
    `required` - 布尔型值，表示是否为必填字段：true-表示必须有数据；false-表示可以没有数据
    `fieldFormula` - 字段公式
    `functionType` - 加总期间函数
    `validationFormula` - 有校性检验公式
    `defaultValue` - 默认值
    `occurrenceFromIndex` - 起始期间
    `occurrenceToIndex` - 结束期间
    `promptMessage` - 提示信息
    `captionName` - 标题名
    `fieldPosition` - 字段位置

    例子：

         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
        			.getWorksheets().getActiveWorksheet();
         sheet.getTimeSeries().addField("aaa",1,10,2,2,"￥#,##0.00",true,"",0,"","",-1,-1,"","aaa","$G$10");

### addField

    public void addField(java.lang.String fieldName,
                         java.lang.String fieldFormula,
                         java.lang.String validationFormula,
                         java.lang.String defaultValue,
                         java.lang.String promptMessage,
                         java.lang.String fieldPosition)

  缺省设置增加字段。

  Parameters:
    `fieldName` - 字段名
    `fieldFormula` - 字段公式
    `validationFormula` - 有效性校验公式
    `defaultValue` - 默认值
    `promptMessage` - 提示信息
    `fieldPosition` - 字段位置

    例子：

         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
        			.getWorksheets().getActiveWorksheet();
         sheet.getTimeSeries().addField("aaa","","","","","$G$10");

### autoDefineSummaryPeriod

    public void autoDefineSummaryPeriod(boolean isMonth,
                                        boolean isSingle,
                                        int autoType,
                                        boolean isAfterAll)

  自动定义加总期间。

  Parameters:
    `isMonth` - 布尔型值，表示加总期间是否针对月的， 如为true，表示是针对月的； 否则，表示不是针对月的
    `isSingle` - 布尔型值，表示针对月的加总期间是否只有季或年
    `autoType` - 为加总期间类型： AUTO_DEFINE_WEEK-加总期间为周； AUTO_DEFINE_MONTH-加总期间为月； AUTO_DEFINE_QUARTER-加总期间为季； AUTO_DEFINE_YEAR-加总期间为年
    `isAfterAll` - 布尔型值，表示加总期间是放在所有基本期间后面还是放在其包含的 基本期间的后面， 如为true，表示加总期间是放在所有基本期间后面； 否则，表示加总期间是放在其包含的基本期间的后面

    例子：

         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
        			.getWorksheets().getActiveWorksheet();
         sheet.getTimeSeries().autoDefineSummaryPeriod(false,false,TimeSeriesConstants.AUTO_DEFINE_WEEK,false);

### customizedDefineSummaryPeriod

    public void customizedDefineSummaryPeriod(java.lang.String summaryPeriodName,
                                              java.lang.String forColumn,
                                              java.lang.String sumAddress)

  自定义加总期间。

  Parameters:
    `summaryPeriodName` - 加总期间名称
    `forColumn` - 加总期间所包含的基本其间
    `sumAddress` - 加总期间在试算表中的位置

    例子：

         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
        			.getWorksheets().getActiveWorksheet();
         sheet.getTimeSeries().customizedDefineSummaryPeriod("aaaa","$H$10","$I$10");

### defineBasePeriod

    public void defineBasePeriod(int basePeriodType,
                                 int periodNumber,
                                 int year,
                                 int month,
                                 int day,
                                 int formatIndex)

  定义基本期间。

  Parameters:
    `basePeriodType` - 基本期间的类型: DAY-表示日；WEEK-表示周； MONTH-表示月；QUARTER-表示季；YEAR-表示年
    `periodNumber` - 基本期间的个数
    `year` - 基本期间的起始年
    `month` - 基本期间的起始月
    `day` - 基本期间的起始日
    `formatIndex` - 基本期间的格式索引

    例子：

         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
        			.getWorksheets().getActiveWorksheet();
         sheet.getTimeSeries().defineBasePeriod(TimeSeriesConstants.YEAR,111,2004,8,6,3);

### deleteConstant

    public void deleteConstant(java.lang.String constantName)

  删除当前时间序列应用常量。

  Parameters:
    `constantName` - 常量名称

### deleteField

    public void deleteField(java.lang.String fieldName)

  删除字段。

  Parameters:
    `fieldName` - 要删除的字段名称

    例子：

         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
        			.getWorksheets().getActiveWorksheet();
         sheet.getTimeSeries().deleteField("bbb");;

### link

    public void link(boolean isWholeTS)

  公式链接。

  Parameters:
    `isWholeTS` - 布尔型值，如为true，表示全时间序列公式链接；否则，非全时间序列公式链接

### modifyBasePeriod

    public void modifyBasePeriod(int newPeriodNumber,
                                 int year,
                                 int month,
                                 int day,
                                 int formatIndex)

  修改基本期间。

  Parameters:
    `newPeriodNumber` - 修改后的基本期间的个数
    `year` - 基本期间起始年
    `month` - 基本期间起始月
    `day` - 基本期间起始日
    `formatIndex` - 基本期间的格式索引

    例子：

         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
        			.getWorksheets().getActiveWorksheet();
         sheet.getTimeSeries().modifyBasePeriod(200,2004,8,6,3);

### modifyConstant

    public void modifyConstant(java.lang.String constantName,
                               java.lang.String constantValue)

  修改当前时间序列应用常量。

  Parameters:
    `constantName` - 常量名称
    `constantValue` - 常量值

### modifyField

    public void modifyField(java.lang.String oldName,
                            java.lang.String newName,
                            int dataType,
                            int dataLength,
                            int dataDecimal,
                            int formatCategory,
                            java.lang.String formatString,
                            boolean required,
                            java.lang.String fieldFormula,
                            int functionType,
                            java.lang.String validationFormula,
                            java.lang.String defaultValue,
                            int occurrenceFromIndex,
                            int occurrenceToIndex,
                            java.lang.String promptMessage,
                            java.lang.String captionName,
                            java.lang.String fieldPosition)

  修改一个字段。

  Parameters:
    `oldName` - 旧的字段名称
    `newName` - 新的字段名称
    `dataType` - 数据的类型：NUMBER-表示数字，CURRENCY-表示货币
    `dataLength` - 数据长度
    `dataDecimal` - 数据的小数位个数不清
    `formatCategory` - 格式化类别：NUMBER_NUMBER-表示数字，NUMBER_CURRENCY-表示货币
    `formatString` - 格式化后的字串样式
    `required` - 布尔型值，表示是否必须有数据：true-表示必须有数据，false-表示可以没有数据
    `fieldFormula` - 字段公式
    `functionType` - 加总期间函数
    `validationFormula` - 校验公式
    `defaultValue` - 缺省值
    `occurrenceFromIndex` - 字段发生起始期间的索引
    `occurrenceToIndex` - 字段发生结束期间的索引
    `promptMessage` - 字段在试算表状态栏中的提示信息
    `captionName` - 字段标题
    `fieldPosition` - 字段在试算表中的位置

    例子：

         Worksheet sheet = Application.getWorkbooks().getActiveWorkbook()
        			.getWorksheets().getActiveWorksheet();
         sheet.getTimeSeries().modifyField("aaa","bbb",1,10,2,2,"￥#,##0.00",true,"",0,"","",-1,-1,"","bbb","$G$11");

### openTemplate

    public void openTemplate(java.lang.String templateName)

  打开时间序列模板。

  Parameters:
    `templateName` - 模板名称

### saveAsTemplate

    public void saveAsTemplate(java.lang.String templateName)

  将当前时间序列应用存为模板。

  Parameters:
    `templateName` - 模板名称

### unlink

    public void unlink(boolean isWholeTS)

  断开公式链接。

  Parameters:
    `isWholeTS` - 布尔型值，如为true，表示全时间序列断开链接；否则，不表示全时间序列断开链接

### validate

    public void validate()

  校验数据有效性。

Overview | Package | Class | Tree | Index | Help

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

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