Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add lvlf type definition and java code 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1173712 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sergey Vladimirov 2011-09-21 15:31:36 +00:00
parent e8a01e22f7
commit cb5d8d9be1
4 changed files with 636 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/java/org/apache/poi/util/LittleEndian.java
View File

@ -185,6 +185,24 @@ public class LittleEndian implements LittleEndianConsts {
data[offset] = (byte) value;
}
/**
* put an unsigned byte value into a byte array
*
* @param data
* the byte array
* @param offset
* a starting offset into the byte array
* @param value
* the short (16-bit) value
*
* @exception ArrayIndexOutOfBoundsException
* may be thrown
*/
public static void putUByte( byte[] data, int offset, short value )
{
data[offset] = (byte) ( value & 0xFF );
}
/**
* put an unsigned short value into a byte array
*

109
src/scratchpad/src/org/apache/poi/hwpf/dev/FieldIterator.java
View File

@ -50,7 +50,7 @@ public class FieldIterator
{
String javaFieldName = RecordUtil.getFieldName( fieldNumber,
fieldName, 0 );
return result + " (" + javaFieldName + ".length() *2)";
return result + " ( " + javaFieldName + ".length() *2)";
}
else if ( "varword".equals( size ) )
{
@ -70,39 +70,55 @@ public class FieldIterator
String result = "";
if ( type.equals( "short[]" ) )
result = "LittleEndian.getSimpleShortArray(data, 0x"
+ Integer.toHexString( offset ) + " + offset," + size + ")";
result = "LittleEndian.getSimpleShortArray( data, 0x"
+ Integer.toHexString( offset ) + " + offset, " + size
+ " )";
else if ( type.equals( "byte[]" ) )
result = "LittleEndian.getByteArray(data, 0x"
+ Integer.toHexString( offset ) + " + offset," + size + ")";
result = "LittleEndian.getByteArray( data, 0x"
+ Integer.toHexString( offset ) + " + offset," + size
+ " )";
else if ( type.equals( "BorderCode" ) )
result = "new BorderCode(data, 0x" + Integer.toHexString( offset )
+ " + offset)";
result = "new BorderCode( data, 0x" + Integer.toHexString( offset )
+ " + offset )";
else if ( type.equals( "Colorref" ) )
result = "new Colorref(data, 0x" + Integer.toHexString( offset )
+ " + offset)";
result = "new Colorref( data, 0x" + Integer.toHexString( offset )
+ " + offset )";
else if ( type.equals( "DateAndTime" ) )
result = "new DateAndTime(data, 0x" + Integer.toHexString( offset )
+ " + offset)";
result = "new DateAndTime( data, 0x" + Integer.toHexString( offset )
+ " + offset )";
else if ( size.equals( "2" ) )
result = "LittleEndian.getShort(data, 0x"
+ Integer.toHexString( offset ) + " + offset)";
result = "LittleEndian.getShort( data, 0x"
+ Integer.toHexString( offset ) + " + offset )";
else if ( size.equals( "4" ) )
if ( type.equals( "long" ) )
{
result = "LittleEndian.getUInt(data, 0x"
+ Integer.toHexString( offset ) + " + offset)";
result = "LittleEndian.getUInt( data, 0x"
+ Integer.toHexString( offset ) + " + offset )";
}
else
{
result = "LittleEndian.getInt(data, 0x"
+ Integer.toHexString( offset ) + " + offset)";
result = "LittleEndian.getInt( data, 0x"
+ Integer.toHexString( offset ) + " + offset )";
}
else if ( size.equals( "1" ) )
result = "data[ 0x" + Integer.toHexString( offset ) + " + offset ]";
if ( type.equals( "short" ) )
{
result = "(short) LittleEndian.getUnsignedByte( data, 0x"
+ Integer.toHexString( offset ) + " + offset )";
}
else if ( type.equals( "int" ) || type.equals( "long" ) )
{
result = "LittleEndian.getUnsignedByte( data, 0x"
+ Integer.toHexString( offset ) + " + offset )";
}
else
{
result = "data[ 0x" + Integer.toHexString( offset )
+ " + offset ]";
}
else if ( type.equals( "double" ) )
result = "LittleEndian.getDouble(data, 0x"
+ Integer.toHexString( offset ) + " + offset)";
+ Integer.toHexString( offset ) + " + offset )";
try
{
@ -124,61 +140,70 @@ public class FieldIterator
String result = "";
if ( type.equals( "short[]" ) )
result = "LittleEndian.putShortArray(data, 0x"
result = "LittleEndian.putShortArray( data, 0x"
+ Integer.toHexString( offset ) + " + offset, "
+ javaFieldName + ");";
+ javaFieldName + " );";
else if ( type.equals( "byte[]" ) )
result = "System.arraycopy(" + javaFieldName + ", 0, data, 0x"
result = "System.arraycopy( " + javaFieldName + ", 0, data, 0x"
+ Integer.toHexString( offset ) + " + offset, "
+ javaFieldName + ".length);";
+ javaFieldName + ".length );";
else if ( type.equals( "BorderCode" ) )
result = javaFieldName + ".serialize(data, 0x"
+ Integer.toHexString( offset ) + " + offset);";
result = javaFieldName + ".serialize( data, 0x"
+ Integer.toHexString( offset ) + " + offset );";
else if ( type.equals( "Colorref" ) )
result = javaFieldName + ".serialize(data, 0x"
+ Integer.toHexString( offset ) + " + offset);";
result = javaFieldName + ".serialize( data, 0x"
+ Integer.toHexString( offset ) + " + offset );";
else if ( type.equals( "DateAndTime" ) )
result = javaFieldName + ".serialize(data, 0x"
+ Integer.toHexString( offset ) + " + offset);";
result = javaFieldName + ".serialize( data, 0x"
+ Integer.toHexString( offset ) + " + offset );";
else if ( size.equals( "2" ) )
if ( type.equals( "short" ) )
{
result = "LittleEndian.putShort(data, 0x"
result = "LittleEndian.putShort( data, 0x"
+ Integer.toHexString( offset ) + " + offset, "
+ javaFieldName + ");";
+ javaFieldName + " );";
}
else if ( type.equals( "int" ) )
{
result = "LittleEndian.putUShort(data, 0x"
result = "LittleEndian.putUShort( data, 0x"
+ Integer.toHexString( offset ) + " + offset, "
+ javaFieldName + ");";
+ javaFieldName + " );";
}
else
{
result = "LittleEndian.putShort(data, 0x"
result = "LittleEndian.putShort( data, 0x"
+ Integer.toHexString( offset ) + " + offset, (short)"
+ javaFieldName + ");";
+ javaFieldName + " );";
}
else if ( size.equals( "4" ) )
if ( type.equals( "long" ) )
{
result = "LittleEndian.putUInt(data, 0x"
result = "LittleEndian.putUInt( data, 0x"
+ Integer.toHexString( offset ) + " + offset, "
+ javaFieldName + ");";
+ javaFieldName + " );";
}
else
{
result = "LittleEndian.putInt(data, 0x"
result = "LittleEndian.putInt( data, 0x"
+ Integer.toHexString( offset ) + " + offset, "
+ javaFieldName + ");";
+ javaFieldName + " );";
}
else if ( size.equals( "1" ) )
result = "data[ 0x" + Integer.toHexString( offset )
+ " + offset] = " + javaFieldName + ";";
if ( type.equals( "byte" ) )
{
result = "data[ 0x" + Integer.toHexString( offset )
+ " + offset ] = " + javaFieldName + ";";
}
else
{
result = "LittleEndian.putUByte( data, 0x"
+ Integer.toHexString( offset ) + " + offset, "
+ javaFieldName + " );";
}
else if ( type.equals( "double" ) )
result = "LittleEndian.putDouble(data, 0x"
+ Integer.toHexString( offset ) + " + offset, "
+ javaFieldName + ");";
+ javaFieldName + " );";
try
{

487
src/scratchpad/src/org/apache/poi/hwpf/model/types/LVLFAbstractType.java Normal file
View File

@ -0,0 +1,487 @@
/* ====================================================================
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.model.types;
import org.apache.poi.util.BitField;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian;
/**
* The LVLF structure contains formatting properties for an individual level in a
list. <p>Class and fields descriptions are quoted from Microsoft Office Word 97-2007
Binary File Format and [MS-DOC] - v20110608 Word (.doc) Binary File Format
* <p>
* NOTE: This source is automatically generated please do not modify this file. Either subclass or
* remove the record in src/types/definitions.
* <p>
* This class is internal. It content or properties may change without notice
* due to changes in our knowledge of internal Microsoft Word binary structures.
* @author Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary File Format
Specification [*.doc] and [MS-DOC] - v20110608 Word (.doc) Binary File Format
*/
@Internal
public abstract class LVLFAbstractType
{
protected int field_1_iStartAt;
protected short field_2_info2;
/**/private static final BitField nfc = new BitField(0x00FF);
/**/private static final BitField jc = new BitField(0x0300);
/**/private static final BitField fLegal = new BitField(0x0400);
/**/private static final BitField fNoRestart = new BitField(0x0800);
/**/private static final BitField fIndentSav = new BitField(0x1000);
/**/private static final BitField fConverted = new BitField(0x2000);
/**/private static final BitField unused1 = new BitField(0x4000);
/**/private static final BitField fTentative = new BitField(0x8000);
protected byte[] field_3_rgbxchNums;
protected byte field_4_ixchFollow;
protected int field_5_dxaIndentSav;
protected int field_6_unused2;
protected short field_7_cbGrpprlChpx;
protected short field_8_cbGrpprlPapx;
protected short field_9_ilvlRestartLim;
protected short field_10_grfhic;
protected LVLFAbstractType()
{
this.field_3_rgbxchNums = new byte[9];
}
protected void fillFields( byte[] data, int offset )
{
field_1_iStartAt = LittleEndian.getInt( data, 0x0 + offset );
field_2_info2 = LittleEndian.getShort( data, 0x4 + offset );
field_3_rgbxchNums = LittleEndian.getByteArray( data, 0x6 + offset,9 );
field_4_ixchFollow = data[ 0xf + offset ];
field_5_dxaIndentSav = LittleEndian.getInt( data, 0x10 + offset );
field_6_unused2 = LittleEndian.getInt( data, 0x14 + offset );
field_7_cbGrpprlChpx = (short) LittleEndian.getUnsignedByte( data, 0x18 + offset );
field_8_cbGrpprlPapx = (short) LittleEndian.getUnsignedByte( data, 0x19 + offset );
field_9_ilvlRestartLim = (short) LittleEndian.getUnsignedByte( data, 0x1a + offset );
field_10_grfhic = (short) LittleEndian.getUnsignedByte( data, 0x1b + offset );
}
public void serialize( byte[] data, int offset )
{
LittleEndian.putInt( data, 0x0 + offset, field_1_iStartAt );
LittleEndian.putShort( data, 0x4 + offset, field_2_info2 );
System.arraycopy( field_3_rgbxchNums, 0, data, 0x6 + offset, field_3_rgbxchNums.length );
data[ 0xf + offset ] = field_4_ixchFollow;
LittleEndian.putInt( data, 0x10 + offset, field_5_dxaIndentSav );
LittleEndian.putInt( data, 0x14 + offset, field_6_unused2 );
LittleEndian.putUByte( data, 0x18 + offset, field_7_cbGrpprlChpx );
LittleEndian.putUByte( data, 0x19 + offset, field_8_cbGrpprlPapx );
LittleEndian.putUByte( data, 0x1a + offset, field_9_ilvlRestartLim );
LittleEndian.putUByte( data, 0x1b + offset, field_10_grfhic );
}
public byte[] serialize()
{
final byte[] result = new byte[ getSize() ];
serialize( result, 0 );
return result;
}
/**
* Size of record
*/
public static int getSize()
{
return 0 + 4 + 2 + 9 + 1 + 4 + 4 + 1 + 1 + 1 + 1;
}
public String toString()
{
StringBuilder builder = new StringBuilder();
builder.append("[LVLF]\n");
builder.append(" .iStartAt = ");
builder.append(" (").append(getIStartAt()).append(" )\n");
builder.append(" .info2 = ");
builder.append(" (").append(getInfo2()).append(" )\n");
builder.append(" .nfc = ").append(getNfc()).append('\n');
builder.append(" .jc = ").append(getJc()).append('\n');
builder.append(" .fLegal = ").append(isFLegal()).append('\n');
builder.append(" .fNoRestart = ").append(isFNoRestart()).append('\n');
builder.append(" .fIndentSav = ").append(isFIndentSav()).append('\n');
builder.append(" .fConverted = ").append(isFConverted()).append('\n');
builder.append(" .unused1 = ").append(isUnused1()).append('\n');
builder.append(" .fTentative = ").append(isFTentative()).append('\n');
builder.append(" .rgbxchNums = ");
builder.append(" (").append(getRgbxchNums()).append(" )\n");
builder.append(" .ixchFollow = ");
builder.append(" (").append(getIxchFollow()).append(" )\n");
builder.append(" .dxaIndentSav = ");
builder.append(" (").append(getDxaIndentSav()).append(" )\n");
builder.append(" .unused2 = ");
builder.append(" (").append(getUnused2()).append(" )\n");
builder.append(" .cbGrpprlChpx = ");
builder.append(" (").append(getCbGrpprlChpx()).append(" )\n");
builder.append(" .cbGrpprlPapx = ");
builder.append(" (").append(getCbGrpprlPapx()).append(" )\n");
builder.append(" .ilvlRestartLim = ");
builder.append(" (").append(getIlvlRestartLim()).append(" )\n");
builder.append(" .grfhic = ");
builder.append(" (").append(getGrfhic()).append(" )\n");
builder.append("[/LVLF]\n");
return builder.toString();
}
/**
* Get the iStartAt field for the LVLF record.
*/
@Internal
public int getIStartAt()
{
return field_1_iStartAt;
}
/**
* Set the iStartAt field for the LVLF record.
*/
@Internal
public void setIStartAt( int field_1_iStartAt )
{
this.field_1_iStartAt = field_1_iStartAt;
}
/**
* Get the info2 field for the LVLF record.
*/
@Internal
public short getInfo2()
{
return field_2_info2;
}
/**
* Set the info2 field for the LVLF record.
*/
@Internal
public void setInfo2( short field_2_info2 )
{
this.field_2_info2 = field_2_info2;
}
/**
* An array of 8-bit integers. Each integer specifies a one-based character offset to a level placeholder in the xst.rgtchar of the LVL that contains this LVLF. This array is zero-terminated, unless it is full. The count of elements in this array, before to the first terminating zero, MUST be less than or equal to the one-based level of the list to which this LVL corresponds. The integers in this array, before the first terminating zero, MUST be in ascending order, and MUST be unique.
*/
@Internal
public byte[] getRgbxchNums()
{
return field_3_rgbxchNums;
}
/**
* An array of 8-bit integers. Each integer specifies a one-based character offset to a level placeholder in the xst.rgtchar of the LVL that contains this LVLF. This array is zero-terminated, unless it is full. The count of elements in this array, before to the first terminating zero, MUST be less than or equal to the one-based level of the list to which this LVL corresponds. The integers in this array, before the first terminating zero, MUST be in ascending order, and MUST be unique.
*/
@Internal
public void setRgbxchNums( byte[] field_3_rgbxchNums )
{
this.field_3_rgbxchNums = field_3_rgbxchNums;
}
/**
* An unsigned integer that specifies the character that follows the number text.
*/
@Internal
public byte getIxchFollow()
{
return field_4_ixchFollow;
}
/**
* An unsigned integer that specifies the character that follows the number text.
*/
@Internal
public void setIxchFollow( byte field_4_ixchFollow )
{
this.field_4_ixchFollow = field_4_ixchFollow;
}
/**
* If fIndentSav is nonzero, this is a signed integer that specifies the size, in twips, of the indent that needs to be removed when the numbering is removed. This MUST be less than or equal to 0x00007BC0 or greater than or equal to 0xFFFF8440. If fIndentSav is zero, this MUST be ignored.
*/
@Internal
public int getDxaIndentSav()
{
return field_5_dxaIndentSav;
}
/**
* If fIndentSav is nonzero, this is a signed integer that specifies the size, in twips, of the indent that needs to be removed when the numbering is removed. This MUST be less than or equal to 0x00007BC0 or greater than or equal to 0xFFFF8440. If fIndentSav is zero, this MUST be ignored.
*/
@Internal
public void setDxaIndentSav( int field_5_dxaIndentSav )
{
this.field_5_dxaIndentSav = field_5_dxaIndentSav;
}
/**
* This field MUST be ignored.
*/
@Internal
public int getUnused2()
{
return field_6_unused2;
}
/**
* This field MUST be ignored.
*/
@Internal
public void setUnused2( int field_6_unused2 )
{
this.field_6_unused2 = field_6_unused2;
}
/**
* An unsigned integer that specifies the size, in bytes, of the grpprlChpx in the LVL that contains this LVLF.
*/
@Internal
public short getCbGrpprlChpx()
{
return field_7_cbGrpprlChpx;
}
/**
* An unsigned integer that specifies the size, in bytes, of the grpprlChpx in the LVL that contains this LVLF.
*/
@Internal
public void setCbGrpprlChpx( short field_7_cbGrpprlChpx )
{
this.field_7_cbGrpprlChpx = field_7_cbGrpprlChpx;
}
/**
* An unsigned integer that specifies the size, in bytes, of the grpprlPapx in the LVL that contains this LVLF.
*/
@Internal
public short getCbGrpprlPapx()
{
return field_8_cbGrpprlPapx;
}
/**
* An unsigned integer that specifies the size, in bytes, of the grpprlPapx in the LVL that contains this LVLF.
*/
@Internal
public void setCbGrpprlPapx( short field_8_cbGrpprlPapx )
{
this.field_8_cbGrpprlPapx = field_8_cbGrpprlPapx;
}
/**
* An unsigned integer that specifies the first (most-significant) zero-based level after which the number sequence of this level does not restart. The number sequence of this level does restart after any level that is more significant than the specified level. This MUST be less than or equal to the zero-based level of the list to which this LVLF corresponds. If fNoRestart is zero, this MUST be ignored. If this level does not have a number sequence (see nfc), this MUST be ignored.
*/
@Internal
public short getIlvlRestartLim()
{
return field_9_ilvlRestartLim;
}
/**
* An unsigned integer that specifies the first (most-significant) zero-based level after which the number sequence of this level does not restart. The number sequence of this level does restart after any level that is more significant than the specified level. This MUST be less than or equal to the zero-based level of the list to which this LVLF corresponds. If fNoRestart is zero, this MUST be ignored. If this level does not have a number sequence (see nfc), this MUST be ignored.
*/
@Internal
public void setIlvlRestartLim( short field_9_ilvlRestartLim )
{
this.field_9_ilvlRestartLim = field_9_ilvlRestartLim;
}
/**
* A grfhic that specifies the HTML incompatibilities of the level..
*/
@Internal
public short getGrfhic()
{
return field_10_grfhic;
}
/**
* A grfhic that specifies the HTML incompatibilities of the level..
*/
@Internal
public void setGrfhic( short field_10_grfhic )
{
this.field_10_grfhic = field_10_grfhic;
}
/**
* Sets the nfc field value.
* An MSONFC, as specified in [MS-OSHARED] section 2.2.1.3, that specifies the format of the level numbers that replace the placeholders for this level in the xst fields of the LVLs in this list. This value MUST not be equal to 0x08, 0x09, 0x0F, or 0x13. If this is equal to 0xFF or 0x17, this level does not have a number sequence and therefore has no number formatting. If this is equal to 0x17, the level uses bullets.
*/
@Internal
public void setNfc( short value )
{
field_2_info2 = (short)nfc.setValue(field_2_info2, value);
}
/**
* An MSONFC, as specified in [MS-OSHARED] section 2.2.1.3, that specifies the format of the level numbers that replace the placeholders for this level in the xst fields of the LVLs in this list. This value MUST not be equal to 0x08, 0x09, 0x0F, or 0x13. If this is equal to 0xFF or 0x17, this level does not have a number sequence and therefore has no number formatting. If this is equal to 0x17, the level uses bullets.
* @return the nfc field value.
*/
@Internal
public short getNfc()
{
return ( short )nfc.getValue(field_2_info2);
}
/**
* Sets the jc field value.
* An unsigned integer that specifies the justification of this level
*/
@Internal
public void setJc( byte value )
{
field_2_info2 = (short)jc.setValue(field_2_info2, value);
}
/**
* An unsigned integer that specifies the justification of this level
* @return the jc field value.
*/
@Internal
public byte getJc()
{
return ( byte )jc.getValue(field_2_info2);
}
/**
* Sets the fLegal field value.
* A bit that specifies whether this level overrides the nfc of all inherited level numbers. If the original nfc of a level number is msonfcArabicLZ, it is preserved. Otherwise, the nfc of the level number is overridden by msonfcArabic.
*/
@Internal
public void setFLegal( boolean value )
{
field_2_info2 = (short)fLegal.setBoolean(field_2_info2, value);
}
/**
* A bit that specifies whether this level overrides the nfc of all inherited level numbers. If the original nfc of a level number is msonfcArabicLZ, it is preserved. Otherwise, the nfc of the level number is overridden by msonfcArabic.
* @return the fLegal field value.
*/
@Internal
public boolean isFLegal()
{
return fLegal.isSet(field_2_info2);
}
/**
* Sets the fNoRestart field value.
* A bit that specifies whether the number sequence of the level does not restart after a level is encountered that is more significant than the level to which this LVLF corresponds
*/
@Internal
public void setFNoRestart( boolean value )
{
field_2_info2 = (short)fNoRestart.setBoolean(field_2_info2, value);
}
/**
* A bit that specifies whether the number sequence of the level does not restart after a level is encountered that is more significant than the level to which this LVLF corresponds
* @return the fNoRestart field value.
*/
@Internal
public boolean isFNoRestart()
{
return fNoRestart.isSet(field_2_info2);
}
/**
* Sets the fIndentSav field value.
* A bit that specifies whether the level indented the text it was applied to and that the indent needs to be removed when numbering is removed. The indent to be removed is stored in dxaIndentSav
*/
@Internal
public void setFIndentSav( boolean value )
{
field_2_info2 = (short)fIndentSav.setBoolean(field_2_info2, value);
}
/**
* A bit that specifies whether the level indented the text it was applied to and that the indent needs to be removed when numbering is removed. The indent to be removed is stored in dxaIndentSav
* @return the fIndentSav field value.
*/
@Internal
public boolean isFIndentSav()
{
return fIndentSav.isSet(field_2_info2);
}
/**
* Sets the fConverted field value.
* A bit that specifies whether the nfc of this LVLF structure was previously a temporary value used for bidirectional compatibility that was converted into a standard MSONFC
*/
@Internal
public void setFConverted( boolean value )
{
field_2_info2 = (short)fConverted.setBoolean(field_2_info2, value);
}
/**
* A bit that specifies whether the nfc of this LVLF structure was previously a temporary value used for bidirectional compatibility that was converted into a standard MSONFC
* @return the fConverted field value.
*/
@Internal
public boolean isFConverted()
{
return fConverted.isSet(field_2_info2);
}
/**
* Sets the unused1 field value.
* This bit MUST be ignored
*/
@Internal
public void setUnused1( boolean value )
{
field_2_info2 = (short)unused1.setBoolean(field_2_info2, value);
}
/**
* This bit MUST be ignored
* @return the unused1 field value.
*/
@Internal
public boolean isUnused1()
{
return unused1.isSet(field_2_info2);
}
/**
* Sets the fTentative field value.
* A bit that specifies whether the format of the level is tentative
*/
@Internal
public void setFTentative( boolean value )
{
field_2_info2 = (short)fTentative.setBoolean(field_2_info2, value);
}
/**
* A bit that specifies whether the format of the level is tentative
* @return the fTentative field value.
*/
@Internal
public boolean isFTentative()
{
return fTentative.isSet(field_2_info2);
}
} // END OF CLASS

64
src/types/definitions/lvlf_type.xml Normal file
View File

@ -0,0 +1,64 @@
<?xml version="1.0"?>
<!--
====================================================================
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.
====================================================================
-->
<record fromfile="true" name="LVLF" package="org.apache.poi.hwpf.model.types">
<suffix>AbstractType</suffix>
<description>The LVLF structure contains formatting properties for an individual level in a
list. &lt;p&gt;Class and fields descriptions are quoted from Microsoft Office Word 97-2007
Binary File Format and [MS-DOC] - v20110608 Word (.doc) Binary File Format
</description>
<author>Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary File Format
Specification [*.doc] and [MS-DOC] - v20110608 Word (.doc) Binary File Format
</author>
<fields>
<field type="int" size="4" name="iStartAt"/>
<field type="short" size="2" name="info2">
<bit mask="0x00FF" name="nfc"
description="An MSONFC, as specified in [MS-OSHARED] section 2.2.1.3, that specifies the format of the level numbers that replace the placeholders for this level in the xst fields of the LVLs in this list. This value MUST not be equal to 0x08, 0x09, 0x0F, or 0x13. If this is equal to 0xFF or 0x17, this level does not have a number sequence and therefore has no number formatting. If this is equal to 0x17, the level uses bullets."/>
<bit mask="0x0300" name="jc"
description="An unsigned integer that specifies the justification of this level"/>
<bit mask="0x0400" name="fLegal"
description="A bit that specifies whether this level overrides the nfc of all inherited level numbers. If the original nfc of a level number is msonfcArabicLZ, it is preserved. Otherwise, the nfc of the level number is overridden by msonfcArabic."/>
<bit mask="0x0800" name="fNoRestart"
description="A bit that specifies whether the number sequence of the level does not restart after a level is encountered that is more significant than the level to which this LVLF corresponds"/>
<bit mask="0x1000" name="fIndentSav"
description="A bit that specifies whether the level indented the text it was applied to and that the indent needs to be removed when numbering is removed. The indent to be removed is stored in dxaIndentSav"/>
<bit mask="0x2000" name="fConverted"
description="A bit that specifies whether the nfc of this LVLF structure was previously a temporary value used for bidirectional compatibility that was converted into a standard MSONFC"/>
<bit mask="0x4000" name="unused1" description="This bit MUST be ignored"/>
<bit mask="0x8000" name="fTentative"
description="A bit that specifies whether the format of the level is tentative"/>
</field>
<field type="byte[]" size="9" name="rgbxchNums"
description="An array of 8-bit integers. Each integer specifies a one-based character offset to a level placeholder in the xst.rgtchar of the LVL that contains this LVLF. This array is zero-terminated, unless it is full. The count of elements in this array, before to the first terminating zero, MUST be less than or equal to the one-based level of the list to which this LVL corresponds. The integers in this array, before the first terminating zero, MUST be in ascending order, and MUST be unique"/>
<field type="byte" size="1" name="ixchFollow"
description="An unsigned integer that specifies the character that follows the number text"/>
<field type="int" size="4" name="dxaIndentSav"
description="If fIndentSav is nonzero, this is a signed integer that specifies the size, in twips, of the indent that needs to be removed when the numbering is removed. This MUST be less than or equal to 0x00007BC0 or greater than or equal to 0xFFFF8440. If fIndentSav is zero, this MUST be ignored"/>
<field type="int" size="4" name="unused2" description="This field MUST be ignored"/>
<field type="short" size="1" name="cbGrpprlChpx"
description="An unsigned integer that specifies the size, in bytes, of the grpprlChpx in the LVL that contains this LVLF"/>
<field type="short" size="1" name="cbGrpprlPapx"
description="An unsigned integer that specifies the size, in bytes, of the grpprlPapx in the LVL that contains this LVLF"/>
<field type="short" size="1" name="ilvlRestartLim"
description="An unsigned integer that specifies the first (most-significant) zero-based level after which the number sequence of this level does not restart. The number sequence of this level does restart after any level that is more significant than the specified level. This MUST be less than or equal to the zero-based level of the list to which this LVLF corresponds. If fNoRestart is zero, this MUST be ignored. If this level does not have a number sequence (see nfc), this MUST be ignored"/>
<field type="short" size="1" name="grfhic"
description="A grfhic that specifies the HTML incompatibilities of the level."/>
</fields>
</record>