public static enum ExcelWorksheet.PseudoFieldName extends java.lang.Enum<ExcelWorksheet.PseudoFieldName>
ExcelWorksheet that can be
accessed from a StringTemplate V4 template. The enumerated fields can be accessed
like ordinary public fields from a StringTemplate V4 template. The dot notation is
used to do so. Taking the first named value excelFile as an
example, one would write <sheet.excelFile> to access the related
pseudo-field.A short explanation of each pseudo-field and a reference to more in-depth information can be found as description of each named value of the enumeration.
Please note, that the pseudo-fields of the base classes RowObjectContainer and ObjectMap are inherited and can be accessed, too.
See RowObjectContainer.PseudoFieldName and ObjectMap.PseudoFieldName, respectively.
A detailed discussion of pseudo-fields and the enumeration of these can be found
in the class description of ObjectMap.
| Enum Constant and Description |
|---|
excelFile
The file designation
ExcelWorksheet.excelFile of the Excel source. |
isRoot
The flag
ExcelWorksheet.isRoot, whether this container is a complete
worksheet and not just a nested sub-group of row objects. |
parentBook
The work book object
ExcelWorksheet.parentBook, this sheet belongs to. |
tabName
The tab name
ExcelWorksheet.tabName of the worksheet in the Excel
source. |
| Modifier and Type | Method and Description |
|---|---|
static ExcelWorksheet.PseudoFieldName |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static ExcelWorksheet.PseudoFieldName[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final ExcelWorksheet.PseudoFieldName excelFile
ExcelWorksheet.excelFile of the Excel source.
From a StringTemplate V4 template it would be accessed with an expression
like <sheet.excelFile>.
public static final ExcelWorksheet.PseudoFieldName tabName
ExcelWorksheet.tabName of the worksheet in the Excel
source.
From a StringTemplate V4 template it would be accessed with an expression
like <sheet.tabName>.
public static final ExcelWorksheet.PseudoFieldName parentBook
ExcelWorksheet.parentBook, this sheet belongs to.
From a StringTemplate V4 template it would be accessed with an expression
like <sheet.parentBook>.
public static final ExcelWorksheet.PseudoFieldName isRoot
ExcelWorksheet.isRoot, whether this container is a complete
worksheet and not just a nested sub-group of row objects.
From a StringTemplate V4 template it would be accessed with an expression
like <if(container.isRoot)>This is the complete worksheet<else>This is a
sub-group of a worksheet<endif>.
public static ExcelWorksheet.PseudoFieldName[] values()
for (ExcelWorksheet.PseudoFieldName c : ExcelWorksheet.PseudoFieldName.values()) System.out.println(c);
public static ExcelWorksheet.PseudoFieldName valueOf(java.lang.String name)
name - the name of the enum constant to be returned.java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is null