Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /* ====================================================================
     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;
 
 
 
 public class Paragraph extends Range implements Cloneable {
     private static POILogger log = POILogFactory.getLoggerParagraph.class );
 
     public final static short SPRM_JC = 0x2403;
     public final static short SPRM_FSIDEBYSIDE = 0x2404;
     public final static short SPRM_FKEEP = 0x2405;
     public final static short SPRM_FKEEPFOLLOW = 0x2406;
     public final static short SPRM_FPAGEBREAKBEFORE = 0x2407;
     public final static short SPRM_BRCL = 0x2408;
     public final static short SPRM_BRCP = 0x2409;
     public final static short SPRM_ILVL = 0x260A;
     public final static short SPRM_ILFO = 0x460B;
     public final static short SPRM_FNOLINENUMB = 0x240C;
     public final static short SPRM_CHGTABSPAPX = (short)0xC60D;
     public final static short SPRM_DXARIGHT = (short)0x840E;
     public final static short SPRM_DXALEFT = (short)0x840F;
     public final static short SPRM_DXALEFT1 = (short)0x8411;
     public final static short SPRM_DYALINE = 0x6412;
     public final static short SPRM_DYABEFORE = (short)0xA413;
     public final static short SPRM_DYAAFTER = (short)0xA414;
     public final static short SPRM_CHGTABS = (short)0xC615;
     public final static short SPRM_FINTABLE = 0x2416;
     public final static short SPRM_FTTP = 0x2417;
     public final static short SPRM_DXAABS = (short)0x8418;
     public final static short SPRM_DYAABS = (short)0x8419;
     public final static short SPRM_DXAWIDTH = (short)0x841A;
     public final static short SPRM_PC = 0x261B;
     public final static short SPRM_WR = 0x2423;
     public final static short SPRM_BRCTOP = 0x6424;
     public final static short SPRM_BRCLEFT = 0x6425;
     public final static short SPRM_BRCBOTTOM = 0x6426;
     public final static short SPRM_BRCRIGHT = 0x6427;
     public final static short SPRM_BRCBAR = 0x6629;
     public final static short SPRM_FNOAUTOHYPH = 0x242A;
     public final static short SPRM_WHEIGHTABS = 0x442B;
     public final static short SPRM_DCS = 0x442C;
     public final static short SPRM_SHD80 = 0x442D;
     public final static short SPRM_SHD = (short)0xC64D;
     public final static short SPRM_DYAFROMTEXT = (short)0x842E;
     public final static short SPRM_DXAFROMTEXT = (short)0x842F;
     public final static short SPRM_FLOCKED = 0x2430;
     public final static short SPRM_FWIDOWCONTROL = 0x2431;
     public final static short SPRM_RULER = (short)0xC632;
     public final static short SPRM_FKINSOKU = 0x2433;
     public final static short SPRM_FWORDWRAP = 0x2434;
     public final static short SPRM_FOVERFLOWPUNCT = 0x2435;
     public final static short SPRM_FTOPLINEPUNCT = 0x2436;
     public final static short SPRM_AUTOSPACEDE = 0x2437;
     public final static short SPRM_AUTOSPACEDN = 0x2438;
     public final static short SPRM_WALIGNFONT = 0x4439;
     public final static short SPRM_FRAMETEXTFLOW = 0x443A;
     public final static short SPRM_ANLD = (short)0xC63E;
     public final static short SPRM_PROPRMARK = (short)0xC63F;
     public final static short SPRM_OUTLVL = 0x2640;
     public final static short SPRM_FBIDI = 0x2441;
     public final static short SPRM_FNUMRMLNS = 0x2443;
     public final static short SPRM_CRLF = 0x2444;
     public final static short SPRM_NUMRM = (short)0xC645;
     public final static short SPRM_USEPGSUSETTINGS = 0x2447;
     public final static short SPRM_FADJUSTRIGHT = 0x2448;
 
     @Internal
     static Paragraph newParagraphRange parentPAPX papx )
     {
         HWPFDocumentCore doc = parent._doc;
        ListTables listTables = doc.getListTables();
        StyleSheet styleSheet = doc.getStyleSheet();
        ParagraphProperties properties = new ParagraphProperties();
        properties.setIstdpapx.getIstd() );
        properties = newParagraph_applyStylePropertiesstyleSheetpapx,
                properties );
        properties = ParagraphSprmUncompressor.uncompressPAPproperties,
                papx.getGrpprl(), 2 );
        if ( properties.getIlfo() != 0 && listTables != null )
        {
            LFO lfo = null;
            try
            {
                lfo = listTables.getLfoproperties.getIlfo() );
            }
            catch ( NoSuchElementException exc )
            {
                .log."Paragraph refers to LFO #",
                        properties.getIlfo(), " that does not exists" );
            }
            if ( lfo != null )
            {
                final ListLevel listLevel = listTables.getLevellfo.getLsid(),
                        properties.getIlvl() );
                if ( listLevel != null && listLevel.getGrpprlPapx() != null )
                {
                    properties = ParagraphSprmUncompressor.uncompressPAP(
                            propertieslistLevel.getGrpprlPapx(), 0 );
                    // reapply style and local PAPX properties
                    properties = newParagraph_applyStylePropertiesstyleSheet,
                            papxproperties );
                    properties = ParagraphSprmUncompressor.uncompressPAP(
                            propertiespapx.getGrpprl(), 2 );
                }
            }
        }
        if ( properties.getIlfo() > 0 )
            return new ListEntrypapxpropertiesparent );
        return new Paragraphpapxpropertiesparent );
    }
            StyleSheet styleSheetPAPX papxParagraphProperties properties )
    {
        if ( styleSheet == null )
            return properties;
        int style = papx.getIstd();
        byte[] grpprl = styleSheet.getPAPXstyle );
        return ParagraphSprmUncompressor.uncompressPAPpropertiesgrpprl, 2 );
    }
  protected short _istd;
  protected SprmBuffer _papx;
    @Deprecated
    protected Paragraphint startIdxInclusiveint endIdxExclusive,
            Table parent )
    {
        superstartIdxInclusiveendIdxExclusiveparent );
        initAll();
        PAPX papx = .get - 1 );
         = papx.getParagraphProperties.getStyleSheet() );
         = papx.getSprmBuf();
         = papx.getIstd();
    }
    @Deprecated
    protected ParagraphPAPX papxRange parent )
    {
        super( Math.maxparent._startpapx.getStart() ), Math.min(
                parent._endpapx.getEnd() ), parent );
         = papx.getParagraphProperties.getStyleSheet() );
         = papx.getSprmBuf();
         = papx.getIstd();
    }
    @Deprecated
    protected ParagraphPAPX papxRange parentint start )
    {
        super( Math.maxparent._startstart ), Math.minparent._end,
                papx.getEnd() ), parent );
         = papx.getParagraphProperties.getStyleSheet() );
         = papx.getSprmBuf();
         = papx.getIstd();
    }
    @Internal
    ParagraphPAPX papxParagraphProperties propertiesRange parent )
    {
        super( Math.maxparent._startpapx.getStart() ), Math.min(
                parent._endpapx.getEnd() ), parent );
         = properties;
         = papx.getSprmBuf();
         = papx.getIstd();
    }

  
Returns the index of the style which applies to this Paragraph. Details of the style can be looked up from the org.apache.poi.hwpf.model.StyleSheet, via org.apache.poi.hwpf.model.StyleSheet.getStyleDescription(int)
  public short getStyleIndex()
  {
     return ;
  }
  public int type()
  {
    return ;
  }
  public boolean isInTable()
  {
    return .getFInTable();
  }

  

Returns:
true, if table trailer paragraph (last in table row), false otherwise
  public boolean isTableRowEnd()
  {
    return .getFTtp() || .getFTtpEmbedded();
  }
  public int getTableLevel()
  {
    return .getItap();
  }

    

Returns:
true, if the end of paragraph mark is really an end of cell mark for a nested table cell, false otherwise
    public boolean isEmbeddedCellMark()
    {
        return .getFInnerTableCell();
    }
  public int getJustification()
  {
    return .getJc();
  }
  public void setJustification(byte jc)
  {
    .setJc(jc);
    .updateSprm(jc);
  }
  public boolean keepOnPage()
  {
    return .getFKeep();
  }
  public void setKeepOnPage(boolean fKeep)
  {
    .setFKeep(fKeep);
    .updateSprm(fKeep);
  }
  public boolean keepWithNext()
  {
    return .getFKeepFollow();
  }
  public void setKeepWithNext(boolean fKeepFollow)
  {
    .setFKeepFollow(fKeepFollow);
    .updateSprm(fKeepFollow);
  }
  public boolean pageBreakBefore()
  {
    return .getFPageBreakBefore();
  }
  public void setPageBreakBefore(boolean fPageBreak)
  {
    .setFPageBreakBefore(fPageBreak);
  }
  public boolean isLineNotNumbered()
  {
    return .getFNoLnn();
  }
  public void setLineNotNumbered(boolean fNoLnn)
  {
    .setFNoLnn(fNoLnn);
  }
  public boolean isSideBySide()
  {
    return .getFSideBySide();
  }
  public void setSideBySide(boolean fSideBySide)
  {
    .setFSideBySide(fSideBySide);
    .updateSprm(fSideBySide);
  }
  public boolean isAutoHyphenated()
  {
    return !.getFNoAutoHyph();
  }
  public void setAutoHyphenated(boolean autoHyph)
  {
    .setFNoAutoHyph(!autoHyph);
    .updateSprm(, !autoHyph);
  }
  public boolean isWidowControlled()
  {
    return .getFWidowControl();
  }
  public void setWidowControl(boolean widowControl)
  {
    .setFWidowControl(widowControl);
    .updateSprm(widowControl);
  }
  public int getIndentFromRight()
  {
    return .getDxaRight();
  }
  public void setIndentFromRight(int dxaRight)
  {
    .setDxaRight(dxaRight);
    .updateSprm(, (short)dxaRight);
  }
  public int getIndentFromLeft()
  {
    return .getDxaLeft();
  }
  public void setIndentFromLeft(int dxaLeft)
  {
    .setDxaLeft(dxaLeft);
    .updateSprm(, (short)dxaLeft);
  }
  public int getFirstLineIndent()
  {
    return .getDxaLeft1();
  }
  public void setFirstLineIndent(int first)
  {
    .setDxaLeft1(first);
    .updateSprm(, (short)first);
  }
  {
    return .getLspd();
  }
  public void setLineSpacing(LineSpacingDescriptor lspd)
  {
    .setLspd(lspd);
  }
  public int getSpacingBefore()
  {
    return .getDyaBefore();
  }
  public void setSpacingBefore(int before)
  {
    .setDyaBefore(before);
    .updateSprm(, (short)before);
  }
  public int getSpacingAfter()
  {
    return .getDyaAfter();
  }
  public void setSpacingAfter(int after)
  {
    .setDyaAfter(after);
    .updateSprm(, (short)after);
  }
  public boolean isKinsoku()
  {
    return .getFKinsoku();
  }
  public void setKinsoku(boolean kinsoku)
  {
    .setFKinsoku(kinsoku);
    .updateSprm(kinsoku);
  }
  public boolean isWordWrapped()
  {
    return .getFWordWrap();
  }
  public void setWordWrapped(boolean wrap)
  {
    .setFWordWrap(wrap);
  }
  public int getFontAlignment()
  {
    return .getWAlignFont();
  }
  public void setFontAlignment(int align)
  {
    .setWAlignFont(align);
    .updateSprm(, (short)align);
  }
  public boolean isVertical()
  {
    return .isFVertical();
  }
  public void setVertical(boolean vertical)
  {
    .setFVertical(vertical);
  }
  public boolean isBackward()
  {
    return .isFBackward();
  }
  public void setBackward(boolean bward)
  {
    .setFBackward(bward);
  }
  {
    return .getBrcTop();
  }
  public void setTopBorder(BorderCode top)
  {
    .setBrcTop(top);
  }
  {
    return .getBrcLeft();
  }
  public void setLeftBorder(BorderCode left)
  {
    .setBrcLeft(left);
  }
  {
    return .getBrcBottom();
  }
  public void setBottomBorder(BorderCode bottom)
  {
    .setBrcBottom(bottom);
  }
  {
    return .getBrcRight();
  }
  public void setRightBorder(BorderCode right)
  {
    .setBrcRight(right);
  }
  {
    return .getBrcBar();
  }
  public void setBarBorder(BorderCode bar)
  {
    .setBrcBar(bar);
  }
  {
    return .getShd();
  }
  public void setShading(ShadingDescriptor shd)
  {
    .setShd(shd);
    //TODO: remove old one
    .addSprmshd.serialize() );
  }
  {
    return .getDcs();
  }
  public void setDropCap(DropCapSpecifier dcs)
  {
    .setDcs(dcs);
  }

  
Returns the ilfo, an index to the document's hpllfo, which describes the automatic number formatting of the paragraph. A value of zero means it isn't numbered.
  public int getIlfo()
  {
     return .getIlfo();
  }

  
Returns the multi-level indent for the paragraph. Will be zero for non-list paragraphs, and the first level of any list. Subsequent levels in hold values 1-8.
  public int getIlvl()
  {
     return .getIlvl();
  }

  
Returns the heading level (1-8), or 9 if the paragraph isn't in a heading style.
  public int getLvl()
  {
     return .getLvl();
  }
  {
    setTableRowEnd(true);
    byte[] grpprl = TableSprmCompressor.compressTableProperty(props);
    .append(grpprl);
  }
  private void setTableRowEnd(boolean val)
  {
    .setFTtp(val);
    .updateSprm(val);
  }

    
Returns number of tabs stops defined for paragraph. Must be >= 0 and <= 64.

Returns:
number of tabs stops defined for paragraph. Must be >= 0 and <= 64
    public int getTabStopsNumber()
    {
        return .getItbdMac();
    }

    
Returns array of positions of itbdMac tab stops

Returns:
array of positions of itbdMac tab stops
    public int[] getTabStopsPositions()
    {
        return .getRgdxaTab();
    }
    public HWPFList getList()
    {
        if ( getIlfo() == 0x000 || getIlfo() == 0xF801 )
        {
            throw new IllegalStateException"Paragraph not in list" );
        }
        HWPFList hwpfList = new HWPFListgetDocument().getStyleSheet(),
                getDocument().getListTables(), getIlfo() );
        return hwpfList;
    }
    public boolean isInList()
    {
        return getIlfo() != 0x000 && getIlfo() != 0xF801;
    }

    
Clone the ParagraphProperties object associated with this Paragraph, so that you can apply the same properties to another Paragraph.
        try {
            return (ParagraphProperties).clone();
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
    public Object clone() throws CloneNotSupportedException
    {
        Paragraph p = (Paragraph)super.clone();
        p._props = (ParagraphProperties).clone();
        //p._baseStyle = _baseStyle;
        p._papx = new SprmBuffer(0);
        return p;
    }
    private short getFrameTextFlow()
    {
        short retVal = 0;
        if (.isFVertical())
        {
            retVal |= 1;
        }
        if (.isFBackward())
        {
            retVal |= 2;
        }
        if (.isFRotateFont())
        {
            retVal |= 4;
        }
        return retVal;
    }
    @Override
    public String toString()
    {
        return "Paragraph [" + getStartOffset() + "; " + getEndOffset() + ")";
    }
New to GrepCode? Check out our FAQ X