SpecialField (i-net Clear Reports)

java.lang.Object
- com.inet.report.Field
- - com.inet.report.SpecialField

All Implemented Interfaces:

NodeParser, com.inet.report.ReferencedObject, java.io.Serializable
```
public class SpecialField
extends Field
```
The SpecialField was created for contents that's source is in the environment of the running engine or of the engine itself. That can be the date or time when the report was printed, or the current page number, the name of the author of the report, etc.
This class is part of the RDC.

See Also:

Fields.getSpecialFieldsCount(), Fields.getSpecialField(int), FieldElement, FieldPart, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONTENT_LOCALE` The type of the `SpecialField` "Content Locale".
`static int`	`CREATION_DATE` The type of the `SpecialField` "Creation Date".
`static int`	`CURRENT_USER_ID` The type of the `SpecialField` "Current User ID".
`static int`	`CURRENT_USER_NAME` The type of the `SpecialField` "Current User Name".
`static int`	`CURRENT_USER_TIME_ZONE` The type of the `SpecialField` "Current User Time Zone".
`static int`	`DATA_DATE` The type of the `SpecialField` "Data Date".
`static int`	`DATA_TIME` The type of the `SpecialField` "Data Time".
`static int`	`DATA_TIME_ZONE` The type of the `SpecialField` "Data Time Zone".
`static int`	`GROUP_NUMBER` The type of the `SpecialField` "Group Number".
`static int`	`GROUP_SELECTION_FORMULA` The type of the `SpecialField` "Group Selection Formula".
`static int`	`HORIZONTAL_PAGE_NUMBER` The type of the `SpecialField` "Horizontal Page Number".
`static int`	`MODIFICATION_DATE` The type of the `SpecialField` "Modification Date".
`static int`	`MODIFICATION_TIME` The type of the `SpecialField` "Modification Time".
`static int`	`PAGE_NUMBER` The type of the `SpecialField` "Page Number".
`static int`	`PAGE_N_OF_M` The type of the `SpecialField` "Page N of M".
`static int`	`PRINT_DATE` The type of the `SpecialField` "Print Date".
`static int`	`PRINT_TIME` The type of the `SpecialField` "Print Time".
`static int`	`PRINT_TIME_ZONE` The type of the `SpecialField` "Print Time Zone".
`static int`	`RECORD_COUNT` The type of the `SpecialField` "Record Count".
`static int`	`RECORD_NUMBER` The type of the `SpecialField` "Record Number".
`static int`	`RECORD_SELECTION_FORMULA` The type of the `SpecialField` "Record Selection Formula".
`static int`	`REPORT_AUTHOR` The type of the `SpecialField` "Report Author".
`static int`	`REPORT_COMMENTS` The type of the `SpecialField` "Report Comments".
`static int`	`REPORT_FILE` The type of the `SpecialField` "Report File".
`static int`	`REPORT_TITLE` The type of the `SpecialField` "Report Title".
`static int`	`SELECTION_LOCALE` The type of the `SpecialField` "Selection Locale".
`static int`	`TOTAL_PAGE_COUNT` The type of the `SpecialField` "Total Page Count".

Fields inherited from class com.inet.report.Field
BINARY, BOOLEAN, CURRENCY, CURSOR, DATABASE_FIELD, DATE, DATETIME, FORMULA_FIELD, GROUP_NAME_FIELD, NUMBER, PARAMETER_FIELD, SORT_FIELD, SPECIAL_FIELD, SQL_FIELD, STRING, SUMMARY_FIELD, TIME, UNKNOWN

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Returns whether this SpecialField is equal to the supplied SpecialField.
`java.lang.String`	`getName()` Returns the value of the property 'name'.
`java.lang.String`	`getOperationName()` Returns the name of the operation of this `SpecialField`, i.e.
`java.lang.String`	`getRefName()` Returns a reference name identifying this SpecialField.
`int`	`getSpecialType()` Returns the type of the special field.
`void`	`setName(java.lang.String newValue)` Sets a new name for this `SpecialField`.
`void`	`setSpecialType(int type)` Sets the type of the special field.

Methods inherited from class com.inet.report.Field
checkNameExists, duplicate, extractReference, getField, getGroup, getPlaceholderName, getType, getValueType, indexOf, paramString, setField, setGroup, setValueType, trimAwayBrackets

Methods inherited from interface com.inet.report.parser.NodeParser
isDOMParser, parseDOM, parseElement, parseEndElement, parseText

- Field Detail
  - PRINT_DATE
```
public static final int PRINT_DATE
```
    The type of the SpecialField "Print Date".
    
    See Also:
    
    Constant Field Values
  - PRINT_TIME
```
public static final int PRINT_TIME
```
    The type of the SpecialField "Print Time".
    
    See Also:
    
    Constant Field Values
  - MODIFICATION_DATE
```
public static final int MODIFICATION_DATE
```
    The type of the SpecialField "Modification Date". This is the last save date of the rpt file.
    
    See Also:
    
    Constant Field Values
  - MODIFICATION_TIME
```
public static final int MODIFICATION_TIME
```
    The type of the SpecialField "Modification Time". This is the last save time of the rpt file.
    
    See Also:
    
    Constant Field Values
  - DATA_DATE
```
public static final int DATA_DATE
```
    The type of the SpecialField "Data Date". Because i-net Clear Reports not supports "Save data with report" this is ever the print date.
    
    See Also:
    
    Constant Field Values
  - DATA_TIME
```
public static final int DATA_TIME
```
    The type of the SpecialField "Data Time". Because i-net Clear Reports not supports "Save data with report" this is ever the print time.
    
    See Also:
    
    Constant Field Values
  - RECORD_NUMBER
```
public static final int RECORD_NUMBER
```
    The type of the SpecialField "Record Number".
    
    See Also:
    
    Constant Field Values
  - PAGE_NUMBER
```
public static final int PAGE_NUMBER
```
    The type of the SpecialField "Page Number".
    
    See Also:
    
    Constant Field Values
  - GROUP_NUMBER
```
public static final int GROUP_NUMBER
```
    The type of the SpecialField "Group Number".
    
    See Also:
    
    Constant Field Values
  - TOTAL_PAGE_COUNT
```
public static final int TOTAL_PAGE_COUNT
```
    The type of the SpecialField "Total Page Count".
    
    See Also:
    
    Constant Field Values
  - REPORT_TITLE
```
public static final int REPORT_TITLE
```
    The type of the SpecialField "Report Title".
    
    See Also:
    
    Constant Field Values
  - REPORT_COMMENTS
```
public static final int REPORT_COMMENTS
```
    The type of the SpecialField "Report Comments".
    
    See Also:
    
    Constant Field Values
  - RECORD_SELECTION_FORMULA
```
public static final int RECORD_SELECTION_FORMULA
```
    The type of the SpecialField "Record Selection Formula".
    
    See Also:
    
    Constant Field Values
  - GROUP_SELECTION_FORMULA
```
public static final int GROUP_SELECTION_FORMULA
```
    The type of the SpecialField "Group Selection Formula".
    
    See Also:
    
    Constant Field Values
  - REPORT_FILE
```
public static final int REPORT_FILE
```
    The type of the SpecialField "Report File".
    
    See Also:
    
    Constant Field Values
  - REPORT_AUTHOR
```
public static final int REPORT_AUTHOR
```
    The type of the SpecialField "Report Author".
    
    See Also:
    
    Constant Field Values
  - CREATION_DATE
```
public static final int CREATION_DATE
```
    The type of the SpecialField "Creation Date".
    
    See Also:
    
    Constant Field Values
  - PAGE_N_OF_M
```
public static final int PAGE_N_OF_M
```
    The type of the SpecialField "Page N of M".
    
    See Also:
    
    Constant Field Values
  - RECORD_COUNT
```
public static final int RECORD_COUNT
```
    The type of the SpecialField "Record Count". The number of records fetched for the report.
    
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - HORIZONTAL_PAGE_NUMBER
```
public static final int HORIZONTAL_PAGE_NUMBER
```
    The type of the SpecialField "Horizontal Page Number".
    
    See Also:
    
    Constant Field Values
  - CURRENT_USER_NAME
```
public static final int CURRENT_USER_NAME
```
    The type of the SpecialField "Current User Name".
    
    See Also:
    
    Constant Field Values
  - CURRENT_USER_ID
```
public static final int CURRENT_USER_ID
```
    The type of the SpecialField "Current User ID".
    
    See Also:
    
    Constant Field Values
  - CURRENT_USER_TIME_ZONE
```
public static final int CURRENT_USER_TIME_ZONE
```
    The type of the SpecialField "Current User Time Zone".
    
    See Also:
    
    Constant Field Values
  - PRINT_TIME_ZONE
```
public static final int PRINT_TIME_ZONE
```
    The type of the SpecialField "Print Time Zone".
    
    See Also:
    
    Constant Field Values
  - DATA_TIME_ZONE
```
public static final int DATA_TIME_ZONE
```
    The type of the SpecialField "Data Time Zone".
    
    See Also:
    
    Constant Field Values
  - CONTENT_LOCALE
```
public static final int CONTENT_LOCALE
```
    The type of the SpecialField "Content Locale".
    
    See Also:
    
    Constant Field Values
  - SELECTION_LOCALE
```
public static final int SELECTION_LOCALE
```
    The type of the SpecialField "Selection Locale".
    
    Since:
    
    8.3
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setName
```
public void setName(java.lang.String newValue)
```
    Sets a new name for this SpecialField. As it is not possible to change the name of a SpecialField this will cause a ReportException to be thrown always.
    
    Specified by:
    
    setName in class Field
    
    Parameters:
    
    newValue - The name which should be set for this SpecialField.
    
    Throws:
    
    java.lang.IllegalStateException - Always, as it is not possible to change the name of a SpecialField.
    
    Since:
    
    6.0
  - getOperationName
```
public java.lang.String getOperationName()
```
    Returns the name of the operation of this SpecialField, i.e. SpecialField RECORD_NUMBER -> "RecordNumber"
    
    Returns:
    
    String Name of the operation
    
    Since:
    
    6.0
  - setSpecialType
```
public void setSpecialType(int type)
```
    Sets the type of the special field. Must be one of the special field constants.
    
    Parameters:
    
    type - the special type of this field
    
    Since:
    
    6.0
    
    See Also:
    
    PRINT_DATE, PRINT_TIME, PRINT_TIME_ZONE, MODIFICATION_DATE, MODIFICATION_TIME, DATA_DATE, DATA_TIME, DATA_TIME_ZONE, RECORD_NUMBER, RECORD_COUNT, PAGE_NUMBER, GROUP_NUMBER, TOTAL_PAGE_COUNT, REPORT_TITLE, REPORT_COMMENTS, RECORD_SELECTION_FORMULA, GROUP_SELECTION_FORMULA, REPORT_FILE, REPORT_AUTHOR, CREATION_DATE, PAGE_N_OF_M, HORIZONTAL_PAGE_NUMBER, CURRENT_USER_NAME, CURRENT_USER_TIME_ZONE, CONTENT_LOCALE, SELECTION_LOCALE
  - getSpecialType
```
public int getSpecialType()
```
    Returns the type of the special field. Will be one of the special field constants.
    
    Returns:
    
    the special field type
    
    Since:
    
    6.0
    
    See Also:
    
    PRINT_DATE, PRINT_TIME, PRINT_TIME_ZONE, MODIFICATION_DATE, MODIFICATION_TIME, DATA_DATE, DATA_TIME, DATA_TIME_ZONE, RECORD_NUMBER, RECORD_COUNT, PAGE_NUMBER, GROUP_NUMBER, TOTAL_PAGE_COUNT, REPORT_TITLE, REPORT_COMMENTS, RECORD_SELECTION_FORMULA, GROUP_SELECTION_FORMULA, REPORT_FILE, REPORT_AUTHOR, CREATION_DATE, PAGE_N_OF_M, HORIZONTAL_PAGE_NUMBER, CURRENT_USER_NAME, CURRENT_USER_TIME_ZONE, CONTENT_LOCALE, SELECTION_LOCALE
  - getRefName
```
public java.lang.String getRefName()
```
    Returns a reference name identifying this SpecialField. The returned name consists of "SpecialField:" and the SpecialField oprtation type.
    
    Overrides:
    
    getRefName in class Field
    
    Returns:
    
    The reference name for this SpecialField.
    
    Since:
    
    6.0
    
    See Also:
    
    Field.getName(), Field.getType()
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns whether this SpecialField is equal to the supplied SpecialField. This will test if the SpecialField operation types are equal.
    
    Parameters:
    
    obj - An instance of SpecialField to compare with this SpecialField.
    
    Returns:
    
    True if the SpecialFields are equal false otherwise.
    
    Since:
    
    6.0
  - getName
```
public java.lang.String getName()
```
    Returns the value of the property 'name'.
    
    Overrides:
    
    getName in class Field
    
    Returns:
    
    The value of the property 'name'.
    
    Since:
    
    9.2
    
    See Also:
    
    Field.setName(java.lang.String), Field.getRefName()

Class SpecialField

Field Summary

Fields inherited from class com.inet.report.Field

Method Summary

Methods inherited from class com.inet.report.Field

Methods inherited from interface com.inet.report.parser.NodeParser

Field Detail

PRINT_DATE

PRINT_TIME

MODIFICATION_DATE

MODIFICATION_TIME

DATA_DATE

DATA_TIME

RECORD_NUMBER

PAGE_NUMBER

GROUP_NUMBER

TOTAL_PAGE_COUNT

REPORT_TITLE

REPORT_COMMENTS

RECORD_SELECTION_FORMULA

GROUP_SELECTION_FORMULA

REPORT_FILE

REPORT_AUTHOR

CREATION_DATE

PAGE_N_OF_M

RECORD_COUNT

HORIZONTAL_PAGE_NUMBER

CURRENT_USER_NAME

CURRENT_USER_ID

CURRENT_USER_TIME_ZONE

PRINT_TIME_ZONE

DATA_TIME_ZONE

CONTENT_LOCALE

SELECTION_LOCALE

Method Detail

setName

getOperationName

setSpecialType

getSpecialType

getRefName

equals

getName