Package com.inet.report
Class SpecialField
java.lang.Object
com.inet.report.Field
com.inet.report.SpecialField
- All Implemented Interfaces:
NodeParser
,com.inet.report.ReferencedObject
,Serializable
The
This class is part of the RDC.
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.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
FOR INTERNAL USE ONLYNested classes/interfaces inherited from class com.inet.report.Field
Field.FieldAttributeTag
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The type of theSpecialField
"Content Locale".static final int
The type of theSpecialField
"Creation Date".static final int
The type of theSpecialField
"Current User ID".static final int
The type of theSpecialField
"Current User Name".static final int
The type of theSpecialField
"Current User Time Zone".static final int
The type of theSpecialField
"Data Date".static final int
The type of theSpecialField
"Data Time".static final int
The type of theSpecialField
"Data Time Zone".static final int
The type of theSpecialField
"Group Number".static final int
The type of theSpecialField
"Group Selection Formula".static final int
The type of theSpecialField
"Horizontal Page Number".static final int
The type of theSpecialField
"Modification Date".static final int
The type of theSpecialField
"Modification Time".static final int
The type of theSpecialField
"Page N of M".static final int
The type of theSpecialField
"Page Number".static final int
The type of theSpecialField
"Print Date".static final int
The type of theSpecialField
"Print Time".static final int
The type of theSpecialField
"Print Time Zone".static final int
The type of theSpecialField
"Record Count".static final int
The type of theSpecialField
"Record Number".static final int
The type of theSpecialField
"Record Selection Formula".static final int
The type of theSpecialField
"Report Author".static final int
The type of theSpecialField
"Report Comments".static final int
The type of theSpecialField
"Report File".static final int
The type of theSpecialField
"Report Title".static final int
The type of theSpecialField
"Selection Locale".static final int
The type of theSpecialField
"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
Modifier and TypeMethodDescriptionboolean
Returns whether this SpecialField is equal to the supplied SpecialField.getName()
Returns the value of the property 'name'.Returns the name of the operation of thisSpecialField
, i.e.Returns a reference name identifying this SpecialField.int
Returns the type of the special field.protected void
saveFieldXML2
(PrintWriter pw, int depth) FOR INTERNAL USE ONLYvoid
Sets a new name for thisSpecialField
.void
setSpecialType
(int type) Sets the type of the special field.Methods inherited from class com.inet.report.Field
addReferenceHolder, checkNameExists, duplicate, extractReference, getField, getGroup, getPlaceholderName, getRealReferenceCount, getReferenceHolderCount, getReferenceHolders, getType, getValueType, indexOf, isDOMParser, isUsed, paramString, parseDOM, parseElement, parseEndElement, parseText, removeReferenceHolder, rename, setField, setGroup, setValueType, trimAwayBrackets
-
Field Details
-
PRINT_DATE
public static final int PRINT_DATEThe type of theSpecialField
"Print Date".- See Also:
-
PRINT_TIME
public static final int PRINT_TIMEThe type of theSpecialField
"Print Time".- See Also:
-
MODIFICATION_DATE
public static final int MODIFICATION_DATEThe type of theSpecialField
"Modification Date". This is the last save date of the rpt file.- See Also:
-
MODIFICATION_TIME
public static final int MODIFICATION_TIMEThe type of theSpecialField
"Modification Time". This is the last save time of the rpt file.- See Also:
-
DATA_DATE
public static final int DATA_DATEThe type of theSpecialField
"Data Date". Because i-net Clear Reports not supports "Save data with report" this is ever the print date.- See Also:
-
DATA_TIME
public static final int DATA_TIMEThe type of theSpecialField
"Data Time". Because i-net Clear Reports not supports "Save data with report" this is ever the print time.- See Also:
-
RECORD_NUMBER
public static final int RECORD_NUMBERThe type of theSpecialField
"Record Number".- See Also:
-
PAGE_NUMBER
public static final int PAGE_NUMBERThe type of theSpecialField
"Page Number".- See Also:
-
GROUP_NUMBER
public static final int GROUP_NUMBERThe type of theSpecialField
"Group Number".- See Also:
-
TOTAL_PAGE_COUNT
public static final int TOTAL_PAGE_COUNTThe type of theSpecialField
"Total Page Count".- See Also:
-
REPORT_TITLE
public static final int REPORT_TITLEThe type of theSpecialField
"Report Title".- See Also:
-
REPORT_COMMENTS
public static final int REPORT_COMMENTSThe type of theSpecialField
"Report Comments".- See Also:
-
RECORD_SELECTION_FORMULA
public static final int RECORD_SELECTION_FORMULAThe type of theSpecialField
"Record Selection Formula".- See Also:
-
GROUP_SELECTION_FORMULA
public static final int GROUP_SELECTION_FORMULAThe type of theSpecialField
"Group Selection Formula".- See Also:
-
REPORT_FILE
public static final int REPORT_FILEThe type of theSpecialField
"Report File".- See Also:
-
REPORT_AUTHOR
public static final int REPORT_AUTHORThe type of theSpecialField
"Report Author".- See Also:
-
CREATION_DATE
public static final int CREATION_DATEThe type of theSpecialField
"Creation Date".- See Also:
-
PAGE_N_OF_M
public static final int PAGE_N_OF_MThe type of theSpecialField
"Page N of M".- See Also:
-
RECORD_COUNT
public static final int RECORD_COUNTThe type of theSpecialField
"Record Count". The number of records fetched for the report.- Since:
- 6.0
- See Also:
-
HORIZONTAL_PAGE_NUMBER
public static final int HORIZONTAL_PAGE_NUMBERThe type of theSpecialField
"Horizontal Page Number".- See Also:
-
CURRENT_USER_NAME
public static final int CURRENT_USER_NAMEThe type of theSpecialField
"Current User Name".- See Also:
-
CURRENT_USER_ID
public static final int CURRENT_USER_IDThe type of theSpecialField
"Current User ID".- See Also:
-
CURRENT_USER_TIME_ZONE
public static final int CURRENT_USER_TIME_ZONEThe type of theSpecialField
"Current User Time Zone".- See Also:
-
PRINT_TIME_ZONE
public static final int PRINT_TIME_ZONEThe type of theSpecialField
"Print Time Zone".- See Also:
-
DATA_TIME_ZONE
public static final int DATA_TIME_ZONEThe type of theSpecialField
"Data Time Zone".- See Also:
-
CONTENT_LOCALE
public static final int CONTENT_LOCALEThe type of theSpecialField
"Content Locale".- See Also:
-
SELECTION_LOCALE
public static final int SELECTION_LOCALEThe type of theSpecialField
"Selection Locale".- Since:
- 8.3
- See Also:
-
-
Method Details
-
setName
Sets a new name for thisSpecialField
. As it is not possible to change the name of aSpecialField
this will cause a ReportException to be thrown always.- Specified by:
setName
in classField
- Parameters:
newValue
- The name which should be set for thisSpecialField
.- Throws:
IllegalStateException
- Always, as it is not possible to change the name of aSpecialField
.- Since:
- 6.0
-
getOperationName
Returns the name of the operation of thisSpecialField
, 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
-
saveFieldXML2
FOR INTERNAL USE ONLY- Specified by:
saveFieldXML2
in classField
- Parameters:
pw
- the print writerdepth
- the current depth
-
getRefName
Returns a reference name identifying this SpecialField. The returned name consists of "SpecialField:" and the SpecialField oprtation type.- Overrides:
getRefName
in classField
- Returns:
- The reference name for this SpecialField.
- Since:
- 6.0
- See Also:
-
equals
Returns whether this SpecialField is equal to the supplied SpecialField. This will test if the SpecialField operation types are equal. -
getName
Returns the value of the property 'name'.
-