cvs commit: jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/usermodel HWPFList.java

[sa...@apache.org]

sackley     2004/03/14 18:57:28

  Added:       src/scratchpad/src/org/apache/poi/hwpf/usermodel
                        HWPFList.java
  Log:
  javadoc and a minor fix
  
  Revision  Changes    Path
  1.1                  jakarta-poi/src/scratchpad/src/org/apache/poi/hwpf/usermodel/HWPFList.java
  
  Index: HWPFList.java
  ===================================================================
  /* ====================================================================
     Copyright 2002-2004   Apache Software Foundation
  
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at
  
         http://www.apache.org/licenses/LICENSE-2.0
  
     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
     limitations under the License.
  ==================================================================== */
  
  package org.apache.poi.hwpf.usermodel;
  
  import org.apache.poi.hwpf.HWPFDocument;
  import org.apache.poi.hwpf.model.ListTables;
  import org.apache.poi.hwpf.model.ListLevel;
  import org.apache.poi.hwpf.model.ListData;
  import org.apache.poi.hwpf.model.ListFormatOverride;
  import org.apache.poi.hwpf.model.StyleSheet;
  
  import org.apache.poi.hwpf.sprm.CharacterSprmCompressor;
  import org.apache.poi.hwpf.sprm.ParagraphSprmCompressor;
  
  /**
   * This class is used to create a list in a Word document. It is used in
   * conjunction with {@link
   * org.apache.poi.hwpf.HWPFDocument#registerList(HWPFList) registerList} in
   * {@link org.apache.poi.hwpf.HWPFDocument HWPFDocument}.
   *
   * In Word, lists are not ranged entities. Lists only act as properties for
   * list entries. Once you register a list, you can add list entries to a
   * document that use the list.
   *
   * @author Ryan Ackley
   */
  public class HWPFList
  {
    private ListData _listData;
    private ListFormatOverride _override;
    private boolean _registered;
    private StyleSheet _styleSheet;
  
    public HWPFList(boolean numbered, StyleSheet styleSheet)
    {
      _listData = new ListData((int)(Math.random() * (double)System.currentTimeMillis()), numbered);
      _override = new ListFormatOverride(_listData.getLsid());
      _styleSheet = styleSheet;
    }
  
    public void setLevelNumberProperties(int level, CharacterProperties chp)
    {
      ListLevel listLevel = _listData.getLevel(level);
      int styleIndex = _listData.getLevelStyle(level);
      CharacterProperties base = _styleSheet.getCharacterStyle(styleIndex);
  
      byte[] grpprl = CharacterSprmCompressor.compressCharacterProperty(chp, base);
      listLevel.setNumberProperties(grpprl);
    }
  
    public void setLevelParagraphProperties(int level, ParagraphProperties pap)
    {
      ListLevel listLevel = _listData.getLevel(level);
      int styleIndex = _listData.getLevelStyle(level);
      ParagraphProperties base = _styleSheet.getParagraphStyle(styleIndex);
  
      byte[] grpprl = ParagraphSprmCompressor.compressParagraphProperty(pap, base);
      listLevel.setLevelProperties(grpprl);
    }
  
    public void setLevelStyle(int level, int styleIndex)
    {
      _listData.setLevelStyle(level, styleIndex);
    }
  
    public ListData getListData()
    {
      return _listData;
    }
  
    public ListFormatOverride getOverride()
    {
      return _override;
    }
  
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: poi-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: poi-dev-help@jakarta.apache.org