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,java.io.Serializable
public class SpecialField extends Field
TheSpecialFieldwas 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
Nested Classes Modifier and Type Class Description static classSpecialField.SpecialFieldNamesFOR INTERNAL USE ONLY-
Nested classes/interfaces inherited from class com.inet.report.Field
Field.FieldAttributeTag
-
-
Field Summary
Fields Modifier and Type Field Description static intCONTENT_LOCALEThe type of theSpecialField"Content Locale".static intCREATION_DATEThe type of theSpecialField"Creation Date".static intCURRENT_USER_IDThe type of theSpecialField"Current User ID".static intCURRENT_USER_NAMEThe type of theSpecialField"Current User Name".static intCURRENT_USER_TIME_ZONEThe type of theSpecialField"Current User Time Zone".static intDATA_DATEThe type of theSpecialField"Data Date".static intDATA_TIMEThe type of theSpecialField"Data Time".static intDATA_TIME_ZONEThe type of theSpecialField"Data Time Zone".static intGROUP_NUMBERThe type of theSpecialField"Group Number".static intGROUP_SELECTION_FORMULAThe type of theSpecialField"Group Selection Formula".static intHORIZONTAL_PAGE_NUMBERThe type of theSpecialField"Horizontal Page Number".static intMODIFICATION_DATEThe type of theSpecialField"Modification Date".static intMODIFICATION_TIMEThe type of theSpecialField"Modification Time".static intPAGE_N_OF_MThe type of theSpecialField"Page N of M".static intPAGE_NUMBERThe type of theSpecialField"Page Number".static intPRINT_DATEThe type of theSpecialField"Print Date".static intPRINT_TIMEThe type of theSpecialField"Print Time".static intPRINT_TIME_ZONEThe type of theSpecialField"Print Time Zone".static intRECORD_COUNTThe type of theSpecialField"Record Count".static intRECORD_NUMBERThe type of theSpecialField"Record Number".static intRECORD_SELECTION_FORMULAThe type of theSpecialField"Record Selection Formula".static intREPORT_AUTHORThe type of theSpecialField"Report Author".static intREPORT_COMMENTSThe type of theSpecialField"Report Comments".static intREPORT_FILEThe type of theSpecialField"Report File".static intREPORT_TITLEThe type of theSpecialField"Report Title".static intSELECTION_LOCALEThe type of theSpecialField"Selection Locale".static intTOTAL_PAGE_COUNTThe 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)Returns whether this SpecialField is equal to the supplied SpecialField.java.lang.StringgetName()Returns the value of the property 'name'.java.lang.StringgetOperationName()Returns the name of the operation of thisSpecialField, i.e.java.lang.StringgetRefName()Returns a reference name identifying this SpecialField.intgetSpecialType()Returns the type of the special field.protected voidsaveFieldXML2(java.io.PrintWriter pw, int depth)FOR INTERNAL USE ONLYvoidsetName(java.lang.String newValue)Sets a new name for thisSpecialField.voidsetSpecialType(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 Detail
-
PRINT_DATE
public static final int PRINT_DATE
The type of theSpecialField"Print Date".- See Also:
- Constant Field Values
-
PRINT_TIME
public static final int PRINT_TIME
The type of theSpecialField"Print Time".- See Also:
- Constant Field Values
-
MODIFICATION_DATE
public static final int MODIFICATION_DATE
The type of theSpecialField"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 theSpecialField"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 theSpecialField"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 theSpecialField"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 theSpecialField"Record Number".- See Also:
- Constant Field Values
-
PAGE_NUMBER
public static final int PAGE_NUMBER
The type of theSpecialField"Page Number".- See Also:
- Constant Field Values
-
GROUP_NUMBER
public static final int GROUP_NUMBER
The type of theSpecialField"Group Number".- See Also:
- Constant Field Values
-
TOTAL_PAGE_COUNT
public static final int TOTAL_PAGE_COUNT
The type of theSpecialField"Total Page Count".- See Also:
- Constant Field Values
-
REPORT_TITLE
public static final int REPORT_TITLE
The type of theSpecialField"Report Title".- See Also:
- Constant Field Values
-
REPORT_COMMENTS
public static final int REPORT_COMMENTS
The type of theSpecialField"Report Comments".- See Also:
- Constant Field Values
-
RECORD_SELECTION_FORMULA
public static final int RECORD_SELECTION_FORMULA
The type of theSpecialField"Record Selection Formula".- See Also:
- Constant Field Values
-
GROUP_SELECTION_FORMULA
public static final int GROUP_SELECTION_FORMULA
The type of theSpecialField"Group Selection Formula".- See Also:
- Constant Field Values
-
REPORT_FILE
public static final int REPORT_FILE
The type of theSpecialField"Report File".- See Also:
- Constant Field Values
-
REPORT_AUTHOR
public static final int REPORT_AUTHOR
The type of theSpecialField"Report Author".- See Also:
- Constant Field Values
-
CREATION_DATE
public static final int CREATION_DATE
The type of theSpecialField"Creation Date".- See Also:
- Constant Field Values
-
PAGE_N_OF_M
public static final int PAGE_N_OF_M
The type of theSpecialField"Page N of M".- See Also:
- Constant Field Values
-
RECORD_COUNT
public static final int RECORD_COUNT
The type of theSpecialField"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 theSpecialField"Horizontal Page Number".- See Also:
- Constant Field Values
-
CURRENT_USER_NAME
public static final int CURRENT_USER_NAME
The type of theSpecialField"Current User Name".- See Also:
- Constant Field Values
-
CURRENT_USER_ID
public static final int CURRENT_USER_ID
The type of theSpecialField"Current User ID".- See Also:
- Constant Field Values
-
CURRENT_USER_TIME_ZONE
public static final int CURRENT_USER_TIME_ZONE
The type of theSpecialField"Current User Time Zone".- See Also:
- Constant Field Values
-
PRINT_TIME_ZONE
public static final int PRINT_TIME_ZONE
The type of theSpecialField"Print Time Zone".- See Also:
- Constant Field Values
-
DATA_TIME_ZONE
public static final int DATA_TIME_ZONE
The type of theSpecialField"Data Time Zone".- See Also:
- Constant Field Values
-
CONTENT_LOCALE
public static final int CONTENT_LOCALE
The type of theSpecialField"Content Locale".- See Also:
- Constant Field Values
-
SELECTION_LOCALE
public static final int SELECTION_LOCALE
The type of theSpecialField"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 thisSpecialField. As it is not possible to change the name of aSpecialFieldthis will cause a ReportException to be thrown always.
-
getOperationName
public java.lang.String 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
protected void saveFieldXML2(java.io.PrintWriter pw, int depth)FOR INTERNAL USE ONLY- Specified by:
saveFieldXML2in classField- Parameters:
pw- the print writerdepth- the current depth
-
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:
getRefNamein classField- 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.
-
getName
public java.lang.String getName()
Returns the value of the property 'name'.- Overrides:
getNamein classField- Returns:
- The value of the property 'name'.
- Since:
- 9.2
- See Also:
Field.setName(java.lang.String),Field.getRefName()
-
-