poi/src/scratchpad/src/org/apache/poi/hwpf/usermodel/CharacterRun.java

/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You 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.common.Duplicatable;
import org.apache.poi.hwpf.HWPFDocument;
import org.apache.poi.hwpf.HWPFOldDocument;
import org.apache.poi.hwpf.model.CHPX;
import org.apache.poi.hwpf.model.FFData;
import org.apache.poi.hwpf.model.Ffn;
import org.apache.poi.hwpf.model.NilPICFAndBinData;
import org.apache.poi.hwpf.model.StyleSheet;
import org.apache.poi.hwpf.sprm.SprmBuffer;
import org.apache.poi.util.Removal;

/**
 * This class represents a run of text that share common properties.
 */
public final class CharacterRun extends Range implements Duplicatable, org.apache.poi.wp.usermodel.CharacterRun {
  public static final short SPRM_FRMARKDEL = (short)0x0800;
  public static final short SPRM_FRMARK = 0x0801;
  public static final short SPRM_FFLDVANISH = 0x0802;
  public static final short SPRM_PICLOCATION = 0x6A03;
  public static final short SPRM_IBSTRMARK = 0x4804;
  public static final short SPRM_DTTMRMARK = 0x6805;
  public static final short SPRM_FDATA = 0x0806;
  public static final short SPRM_SYMBOL = 0x6A09;
  public static final short SPRM_FOLE2 = 0x080A;
  public static final short SPRM_HIGHLIGHT = 0x2A0C;
  public static final short SPRM_OBJLOCATION = 0x680E;
  public static final short SPRM_ISTD = 0x4A30;
  public static final short SPRM_FBOLD = 0x0835;
  public static final short SPRM_FITALIC = 0x0836;
  public static final short SPRM_FSTRIKE = 0x0837;
  public static final short SPRM_FOUTLINE = 0x0838;
  public static final short SPRM_FSHADOW = 0x0839;
  public static final short SPRM_FSMALLCAPS = 0x083A;
  public static final short SPRM_FCAPS = 0x083B;
  public static final short SPRM_FVANISH = 0x083C;
  public static final short SPRM_KUL = 0x2A3E;
  public static final short SPRM_DXASPACE = (short)0x8840;
  public static final short SPRM_LID = 0x4A41;
  public static final short SPRM_ICO = 0x2A42;
  public static final short SPRM_HPS = 0x4A43;
  public static final short SPRM_HPSPOS = 0x4845;
  public static final short SPRM_ISS = 0x2A48;
  public static final short SPRM_HPSKERN = 0x484B;
  public static final short SPRM_YSRI = 0x484E;
  public static final short SPRM_RGFTCASCII = 0x4A4F;
  public static final short SPRM_RGFTCFAREAST = 0x4A50;
  public static final short SPRM_RGFTCNOTFAREAST = 0x4A51;
  public static final short SPRM_CHARSCALE = 0x4852;
  public static final short SPRM_FDSTRIKE = 0x2A53;
  public static final short SPRM_FIMPRINT = 0x0854;
  public static final short SPRM_FSPEC = 0x0855;
  public static final short SPRM_FOBJ = 0x0856;
  public static final short SPRM_PROPRMARK = (short)0xCA57;
  public static final short SPRM_FEMBOSS = 0x0858;
  public static final short SPRM_SFXTEXT = 0x2859;
  public static final short SPRM_DISPFLDRMARK = (short)0xCA62;
  public static final short SPRM_IBSTRMARKDEL = 0x4863;
  public static final short SPRM_DTTMRMARKDEL = 0x6864;
  public static final short SPRM_BRC = 0x6865;
  public static final short SPRM_SHD = 0x4866;
  public static final short SPRM_IDSIRMARKDEL = 0x4867;
  public static final short SPRM_CPG = 0x486B;
  public static final short SPRM_NONFELID = 0x486D;
  public static final short SPRM_FELID = 0x486E;
  public static final short SPRM_IDCTHINT = 0x286F;

  protected short _istd;
  protected SprmBuffer _chpx;
  protected CharacterProperties _props;

  /**
   *
   * @param chpx The chpx this object is based on.
   * @param ss The stylesheet for the document this run belongs to.
   * @param istd The style index if this run's base style.
   * @param parent The parent range of this character run (usually a paragraph).
   */
  CharacterRun(CHPX chpx, StyleSheet ss, short istd, Range parent)
  {
    super(Math.max(parent._start, chpx.getStart()), Math.min(parent._end, chpx.getEnd()), parent);
    _props = chpx.getCharacterProperties(ss, istd);
    _chpx = chpx.getSprmBuf();
    _istd = istd;
  }

  CharacterRun(CharacterRun other) {
    super(other);
    _istd = other._istd;
    _chpx = (other._chpx == null) ? null : other._chpx.copy();
    _props = (other._props == null) ? null : other._props.copy();
  }

  /**
   * Here for runtime type determination using a switch statement convenient.
   *
   * @return TYPE_CHARACTER
   */
  @SuppressWarnings("deprecation")
  public int type()
  {
    return TYPE_CHARACTER;
  }

  public boolean isMarkedDeleted()
  {
    return _props.isFRMarkDel();
  }

  public void markDeleted(boolean mark)
  {
    _props.setFRMarkDel(mark);

    byte newVal = (byte)(mark ? 1 : 0);
    _chpx.updateSprm(SPRM_FRMARKDEL, newVal);

  }

  public boolean isBold()
  {
    return _props.isFBold();
  }

  public void setBold(boolean bold)
  {
    _props.setFBold(bold);

    byte newVal = (byte)(bold ? 1 : 0);
    _chpx.updateSprm(SPRM_FBOLD, newVal);

  }

  public boolean isItalic()
  {
    return _props.isFItalic();
  }

  public void setItalic(boolean italic)
  {
    _props.setFItalic(italic);

    byte newVal = (byte)(italic ? 1 : 0);
    _chpx.updateSprm(SPRM_FITALIC, newVal);

  }

  public boolean isOutlined()
  {
    return _props.isFOutline();
  }

  public void setOutline(boolean outlined)
  {
    _props.setFOutline(outlined);

    byte newVal = (byte)(outlined ? 1 : 0);
    _chpx.updateSprm(SPRM_FOUTLINE, newVal);

  }

  public boolean isFldVanished()
  {
    return _props.isFFldVanish();
  }

  public void setFldVanish(boolean fldVanish)
  {
    _props.setFFldVanish(fldVanish);

    byte newVal = (byte)(fldVanish ? 1 : 0);
    _chpx.updateSprm(SPRM_FFLDVANISH, newVal);

  }

  public boolean isSmallCaps()
  {
    return _props.isFSmallCaps();
  }

  public void setSmallCaps(boolean smallCaps)
  {
    _props.setFSmallCaps(smallCaps);

    byte newVal = (byte)(smallCaps ? 1 : 0);
    _chpx.updateSprm(SPRM_FSMALLCAPS, newVal);

  }

  public boolean isCapitalized()
  {
    return _props.isFCaps();
  }

  public void setCapitalized(boolean caps)
  {
    _props.setFCaps(caps);

    byte newVal = (byte)(caps ? 1 : 0);
    _chpx.updateSprm(SPRM_FCAPS, newVal);

  }

  public boolean isVanished()
  {
    return _props.isFVanish();
  }

  public void setVanished(boolean vanish)
  {
    _props.setFVanish(vanish);

    byte newVal = (byte)(vanish ? 1 : 0);
    _chpx.updateSprm(SPRM_FVANISH, newVal);

  }

  public boolean isMarkedInserted()
  {
    return _props.isFRMark();
  }

  public void markInserted(boolean mark)
  {
    _props.setFRMark(mark);

    byte newVal = (byte)(mark ? 1 : 0);
    _chpx.updateSprm(SPRM_FRMARK, newVal);

  }

  public boolean isStrikeThrough()
  {
    return _props.isFStrike();
  }

  public void setStrikeThrough(boolean strike)
  {
      strikeThrough(strike);
  }
  public void strikeThrough(boolean strike)
  {
    _props.setFStrike(strike);

    byte newVal = (byte)(strike ? 1 : 0);
    _chpx.updateSprm(SPRM_FSTRIKE, newVal);

  }

  public boolean isShadowed()
  {
    return _props.isFShadow();
  }

  public void setShadow(boolean shadow)
  {
    _props.setFShadow(shadow);

    byte newVal = (byte)(shadow ? 1 : 0);
    _chpx.updateSprm(SPRM_FSHADOW, newVal);

  }

  public boolean isEmbossed()
  {
    return _props.isFEmboss();
  }

  public void setEmbossed(boolean emboss)
  {
    _props.setFEmboss(emboss);

    byte newVal = (byte)(emboss ? 1 : 0);
    _chpx.updateSprm(SPRM_FEMBOSS, newVal);

  }

  public boolean isImprinted()
  {
    return _props.isFImprint();
  }

  public void setImprinted(boolean imprint)
  {
    _props.setFImprint(imprint);

    byte newVal = (byte)(imprint ? 1 : 0);
    _chpx.updateSprm(SPRM_FIMPRINT, newVal);

  }

  public boolean isDoubleStrikeThrough()
  {
    return _props.isFDStrike();
  }

  public void setDoubleStrikethrough(boolean dstrike)
  {
    _props.setFDStrike(dstrike);

    byte newVal = (byte)(dstrike ? 1 : 0);
    _chpx.updateSprm(SPRM_FDSTRIKE, newVal);

  }

  public void setFtcAscii(int ftcAscii)
  {
    _props.setFtcAscii(ftcAscii);

    _chpx.updateSprm(SPRM_RGFTCASCII, (short)ftcAscii);

  }

  public void setFtcFE(int ftcFE)
  {
    _props.setFtcFE(ftcFE);

    _chpx.updateSprm(SPRM_RGFTCFAREAST, (short)ftcFE);

  }

  public void setFtcOther(int ftcOther)
  {
    _props.setFtcOther(ftcOther);

    _chpx.updateSprm(SPRM_RGFTCNOTFAREAST, (short)ftcOther);

  }

  public int getFontSize()
  {
    return _props.getHps();
  }

  public void setFontSize(int halfPoints)
  {
    _props.setHps(halfPoints);

    _chpx.updateSprm(SPRM_HPS, (short)halfPoints);

  }

  public int getCharacterSpacing()
  {
    return _props.getDxaSpace();
  }

  public void setCharacterSpacing(int twips)
  {
    _props.setDxaSpace(twips);

    _chpx.updateSprm(SPRM_DXASPACE, twips);

  }

  public short getSubSuperScriptIndex()
  {
    return _props.getIss();
  }

  public void setSubSuperScriptIndex(short iss)
  {
    _props.setDxaSpace(iss);

    _chpx.updateSprm(SPRM_DXASPACE, iss);

  }

  public int getUnderlineCode()
  {
    return _props.getKul();
  }

  public void setUnderlineCode(int kul)
  {
    _props.setKul((byte)kul);
    _chpx.updateSprm(SPRM_KUL, (byte)kul);
  }

  public int getColor()
  {
    return _props.getIco();
  }

  public void setColor(int color)
  {
    _props.setIco((byte)color);
    _chpx.updateSprm(SPRM_ICO, (byte)color);
  }

  public int getVerticalOffset()
  {
    return _props.getHpsPos();
  }

  public void setVerticalOffset(int hpsPos)
  {
    _props.setHpsPos((short) hpsPos);
    _chpx.updateSprm(SPRM_HPSPOS, (byte)hpsPos);
  }

  public int getKerning()
  {
    return _props.getHpsKern();
  }

  public void setKerning(int kern)
  {
    _props.setHpsKern(kern);
    _chpx.updateSprm(SPRM_HPSKERN, (short)kern);
  }

  public boolean isHighlighted()
  {
    return _props.isFHighlight();
  }

  public byte getHighlightedColor()
  {
      return _props.getIcoHighlight();
  }

  public void setHighlighted(byte color)
  {
    _props.setFHighlight(true);
    _props.setIcoHighlight(color);
    _chpx.updateSprm(SPRM_HIGHLIGHT, color);
  }

  public String getFontName()
  {
    if (_doc instanceof HWPFOldDocument) {
      return ((HWPFOldDocument) _doc).getOldFontTable().getMainFont(_props.getFtcAscii());
    }

    if (_doc.getFontTable() == null)
      // old word format
      return null;

    return _doc.getFontTable().getMainFont(_props.getFtcAscii());
  }

  public boolean isSpecialCharacter()
  {
    return _props.isFSpec();
  }

  public void setSpecialCharacter(boolean spec)
  {
    _props.setFSpec(spec);

    byte newVal = (byte)(spec ? 1 : 0);
    _chpx.updateSprm(SPRM_FSPEC, newVal);
  }

  public boolean isObj()
  {
    return _props.isFObj();
  }

  public void setObj(boolean obj)
  {
    _props.setFObj(obj);

    byte newVal = (byte)(obj ? 1 : 0);
    _chpx.updateSprm(SPRM_FOBJ, newVal);
  }

  public int getPicOffset()
  {
    return _props.getFcPic();
  }

  public void setPicOffset(int offset)
  {
    _props.setFcPic(offset);
    _chpx.updateSprm(SPRM_PICLOCATION, offset);
  }

  /**
   * Does the picture offset represent picture
   *  or binary data?
   * If it's set, then the picture offset refers to
   *  a NilPICFAndBinData structure, otherwise to a
   *  PICFAndOfficeArtData
   */
  public boolean isData()
  {
    return _props.isFData();
  }

  public void setData(boolean data)
  {
    _props.setFData(data);

    byte newVal = (byte)(data ? 1 : 0);
    _chpx.updateSprm(SPRM_FOBJ, newVal);
  }

  public boolean isOle2()
  {
    return _props.isFOle2();
  }

  public void setOle2(boolean ole)
  {
    _props.setFOle2(ole);

    byte newVal = (byte)(ole ? 1 : 0);
    _chpx.updateSprm(SPRM_FOBJ, newVal);
  }

  public int getObjOffset()
  {
    return _props.getFcObj();
  }

  public void setObjOffset(int obj)
  {
    _props.setFcObj(obj);
    _chpx.updateSprm(SPRM_OBJLOCATION, obj);
  }

  /**
  * Get the ico24 field for the CHP record.
  */
  public int getIco24()
  {
    return _props.getIco24();
  }

  /**
   * Set the ico24 field for the CHP record.
   */
  public void setIco24(int colour24)
  {
    _props.setIco24(colour24);
  }

  /**
   * Used to create a deep copy of this object.
   *
   * @return A deep copy.
   */
  @Override
  @SuppressWarnings("squid:S2975")
  @Deprecated
  @Removal(version = "5.0.0")
  public CharacterRun clone() {
    return copy();
  }

  @Override
  public CharacterRun copy() {
    return new CharacterRun(this);
  }

  /**
   * Returns true, if the CharacterRun is a special character run containing a symbol, otherwise false.
   *
   * <p>In case of a symbol, the {@link #text()} method always returns a single character 0x0028, but word actually stores
   * the character in a different field. Use {@link #getSymbolCharacter()} to get that character and {@link #getSymbolFont()}
   * to determine its font.
   */
  public boolean isSymbol()
  {
    return isSpecialCharacter() && text().equals("\u0028");
  }

  /**
   * Returns the symbol character, if this is a symbol character run.
   *
   * @see #isSymbol()
   * @throws IllegalStateException If this is not a symbol character run: call {@link #isSymbol()} first.
   */
  public char getSymbolCharacter()
  {
    if (isSymbol()) {
      return (char)_props.getXchSym();
    } else
      throw new IllegalStateException("Not a symbol CharacterRun");
  }

  /**
   * Returns the symbol font, if this is a symbol character run. Might return null, if the font index is not found in the font table.
   *
   * @see #isSymbol()
   * @throws IllegalStateException If this is not a symbol character run: call {@link #isSymbol()} first.
   */
  public Ffn getSymbolFont()
  {
    if (isSymbol()) {
      if (_doc.getFontTable() == null)
        return null;

      // Fetch all font names
      Ffn[] fontNames = _doc.getFontTable().getFontNames();

      // Try to find the name of the font for our symbol
      if (fontNames.length <= _props.getFtcSym())
        return null;

      return fontNames[_props.getFtcSym()];
    } else
      throw new IllegalStateException("Not a symbol CharacterRun");
  }

  public BorderCode getBorder() {
    return _props.getBrc();
  }

  public int getLanguageCode() {
      return _props.getLidDefault();
  }

  /**
   * <p>Returns the index of the base style which applies to
   *  this Run. Details of the style can be looked up
   *  from the {@link StyleSheet}, via
   *  {@link StyleSheet#getStyleDescription(int)}.</p>
   * <p>Note that runs typically override some of the style
   *  properties from the base, so normally style information
   *  should be fetched directly from the {@link CharacterRun}
   *  itself.</p>
   */
  public short getStyleIndex() {
    return _istd;
  }

  public String toString() {
     String text = text();
     return "CharacterRun of " + text.length() + " characters - " + text;
  }

    public String[] getDropDownListValues()
    {
        if ( getDocument() instanceof HWPFDocument )
        {
            char c = _text.charAt( _start );
            if ( c == 0x01 )
            {
                NilPICFAndBinData data = new NilPICFAndBinData(
                        ( (HWPFDocument) getDocument() ).getDataStream(),
                        getPicOffset() );
                FFData ffData = new FFData( data.getBinData(), 0 );

                return ffData.getDropList();
            }
        }
        return null;
    }

    public Integer getDropDownListDefaultItemIndex()
    {
        if ( getDocument() instanceof HWPFDocument )
        {
            char c = _text.charAt( _start );
            if ( c == 0x01 )
            {
                NilPICFAndBinData data = new NilPICFAndBinData(
                        ( (HWPFDocument) getDocument() ).getDataStream(),
                        getPicOffset() );
                FFData ffData = new FFData( data.getBinData(), 0 );

                return Integer.valueOf( ffData.getDefaultDropDownItemIndex() );
            }
        }
        return null;
    }

}