public class SortField extends Field implements com.inet.report.ReferenceHolder, Validatable
FieldElement
.Modifier and Type | Field and Description |
---|---|
static int |
ASCENDING_ALPHA_NUMERIC_ORDER
Sort records ascending.
|
static int |
ASCENDING_ORDER
Sort records ascending.
|
static int |
DESCENDING_ALPHA_NUMERIC_ORDER
Sort records descending.
|
static int |
DESCENDING_ORDER
Sort records descending.
|
static int |
ORIGINAL_ORDER
Do not sort records, let it unsorted.
|
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
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Indicates whether some other
SortField is "equal to" this one. |
int |
getSort()
Returns the value of the property 'sort direction'.
|
FormulaField |
getSortDirectionFormula()
Returns the formula of sort direction for this sort field.
|
int |
getValueType()
Returns the value type (or return type) of the field.
|
void |
setName(java.lang.String name)
Sets the name of the sort field.
|
void |
setSort(int sort)
Sets the value of the property 'sort direction'.
|
void |
setSortDirectionFormula(FormulaField formula)
Sets the formula of sort direction.
|
void |
updateName()
Updates the field's ref name.
|
Validity |
validate()
Check if the object is valid and returns the state and details of possible errors.
|
checkNameExists, duplicate, extractReference, getField, getGroup, getName, getPlaceholderName, getRefName, getType, indexOf, paramString, setField, setGroup, setValueType, trimAwayBrackets
isDOMParser, parseDOM, parseElement, parseEndElement, parseText
public static final int ASCENDING_ORDER
public static final int DESCENDING_ORDER
public static final int ORIGINAL_ORDER
public static final int ASCENDING_ALPHA_NUMERIC_ORDER
public static final int DESCENDING_ALPHA_NUMERIC_ORDER
public void setName(java.lang.String name) throws ReportException
setName
in class Field
name
- The name of the sort field for example, Users.UserIDReportException
- if no database field with this name existsjava.lang.IllegalArgumentException
- if a sort field with name equals name already existspublic void setSort(int sort)
sort
- The new value of the property 'sort direction'.java.lang.IllegalArgumentException
- on illegal sort direction valuessetSortDirectionFormula(FormulaField formula)
,
ASCENDING_ORDER
,
DESCENDING_ORDER
,
ASCENDING_ALPHA_NUMERIC_ORDER
,
DESCENDING_ALPHA_NUMERIC_ORDER
,
ORIGINAL_ORDER
public int getSort()
ASCENDING_ORDER
,
DESCENDING_ORDER
,
ORIGINAL_ORDER
,
setSort(int)
public void setSortDirectionFormula(FormulaField formula) throws ReportException
formula
- for sort direction or null
to remove the sort direction formula.ReportException
- Wrong formula, formula type or return value of formulapublic FormulaField getSortDirectionFormula()
setSortDirectionFormula(FormulaField formula)
public boolean equals(java.lang.Object obj)
SortField
is "equal to" this one.obj
- the reference SortField
with which to compare.true
if this SortField
is the same as the SortField
argument; false
otherwise.public int getValueType()
getValueType
in class Field
Field.UNKNOWN
if the current value of the 'field' property is not set.
Use validate()
to check this.Field.NUMBER
,
Field.CURRENCY
,
Field.BOOLEAN
,
Field.DATE
,
Field.TIME
,
Field.STRING
,
Field.DATETIME
public void updateName()
Field.getRefName()
.Field.getRefName()
public Validity validate()
validate
in interface Validatable
Copyright © 1999-2020 by i-net software GmbH