|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.Value
com.crystaldecisions.sdk.occa.report.data.ParameterFieldValue
com.crystaldecisions.sdk.occa.report.data.ParameterFieldRangeValue
This object stores the value for a ranged parameter. This object contains the upper bound, the lower bound range, and how the two are treated.
Constructor Summary | |
ParameterFieldRangeValue()
|
|
ParameterFieldRangeValue(IParameterFieldRangeValue src)
|
Method Summary | |
java.lang.Object |
clone(boolean deepClone)
Returns the new object that has been cloned. |
java.lang.String |
computeText()
The computeText method returns a String representation
of the field value that can be used in a report formula.
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
Copies the object. |
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only. |
java.lang.String |
displayText(java.util.Locale locale)
Returns the field's value as a localized and formatted String . |
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
java.lang.Object |
getBeginValue()
Returns the lower-bound value of the range. |
java.lang.Object |
getEndValue()
Returns the upper-bound value of the range. |
RangeValueBoundType |
getLowerBoundType()
Returns how the lower bound of the range is treated. |
RangeValueBoundType |
getUpperBoundType()
Returns how the upper bound of the range is treated. |
boolean |
hasContent(java.lang.Object srcParameterFieldRangeValue)
Returns true if this object contains the same elements
as the passed in object. |
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setBeginValue(java.lang.Object beginValue)
Sets the lower-bound value of the range. |
void |
setEndValue(java.lang.Object endValue)
Returns the upper-bound value of the range. |
void |
setLowerBoundType(RangeValueBoundType lowerBoundType)
Sets how the lower bound of the range is treated. |
void |
setUpperBoundType(RangeValueBoundType upperBoundType)
Sets how the upper bound of the range is treated. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
Methods inherited from class com.crystaldecisions.sdk.occa.report.data.ParameterFieldValue |
getDescription, setDescription, startElement |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IParameterFieldValue |
getDescription, setDescription |
Constructor Detail |
public ParameterFieldRangeValue(IParameterFieldRangeValue src)
public ParameterFieldRangeValue()
Method Detail |
public java.lang.Object clone(boolean deepClone)
IClone
Returns the new object that has been cloned.
clone
in interface IClone
clone
in class ParameterFieldValue
public java.lang.String computeText()
IValue
The computeText
method returns a String
representation
of the field value that can be used in a report formula.
The String
is not formatted or localized.
The syntax will always be Crystal syntax.
If the field contains a date, computeText
returns Date(x, x, x); if it contains a date and time,
computeText
returns DateTime(x, x, x, x, x, x).
However, when the date is 1900, 0, 1 (the Java start date),
ComputeText returns Time(x, x, x). If you want to set a field
to a time value only (that is, with no date), you should set
the date to 1900, 0, 1, so that computeText
will retrieve
the correct information.
computeText
in interface IValue
computeText
in class Value
public void copyTo(java.lang.Object destObject, boolean deepCopy)
IClone
Copies the object.
copyTo
in interface IClone
copyTo
in class ParameterFieldValue
public java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
Value
For internal use only.
createMember
in class ParameterFieldValue
public java.lang.String displayText(java.util.Locale locale)
IValue
Returns the field's value as a localized and formatted
String
. The Locale can be a java.util.Locale
value.
The value is formatted according to the locale.
The user is required to pass in a locale; the system
default locale or user default locale is not used.
If the field contains a date, displayText
returns a
locale-specific date string; if it contains a date and time,
displayText
returns a locale-specific date time String
;
if it contains a time String
, displayText
returns a locale-specific
time String
.
displayText
in interface IValue
displayText
in class Value
public void endElement(java.lang.String eleName, java.util.Map objState)
Value
For internal use only.
endElement
in class ParameterFieldValue
public java.lang.Object getBeginValue()
IParameterFieldRangeValue
Returns the lower-bound value of the range.
Use the IParameterFieldRangeValue.getEndValue()
method to determine
the upper-bound value.
getBeginValue
in interface IParameterFieldRangeValue
Object
.public java.lang.Object getEndValue()
IParameterFieldRangeValue
Returns the upper-bound value of the range.
Use the IParameterFieldRangeValue.getBeginValue()
method to determine
the lower-bound value.
getEndValue
in interface IParameterFieldRangeValue
Object
.public RangeValueBoundType getLowerBoundType()
IParameterFieldRangeValue
Returns how the lower bound of the range is treated. Can also specify that the range has no lower bound.
getLowerBoundType
in interface IParameterFieldRangeValue
RangeValueBoundType
Object
.public RangeValueBoundType getUpperBoundType()
IParameterFieldRangeValue
Returns how the upper bound of the range is treated. Can also specify that the range has no upper bound.
getUpperBoundType
in interface IParameterFieldRangeValue
RangeValueBoundType
object.public boolean hasContent(java.lang.Object srcParameterFieldRangeValue)
IClone
Returns true
if this object contains the same elements
as the passed in object.
hasContent
in interface IClone
hasContent
in class ParameterFieldValue
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
Value
For internal use only.
readElement
in class ParameterFieldValue
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
Value
For internal use only.
save
in class ParameterFieldValue
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
Value
For internal use only.
save
in class ParameterFieldValue
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
Value
For internal use only.
saveContents
in class ParameterFieldValue
java.io.IOException
public void setBeginValue(java.lang.Object beginValue)
IParameterFieldRangeValue
Sets the lower-bound value of the range.
Use the IParameterFieldRangeValue.getEndValue()
method to determine
the upper-bound value.
setBeginValue
in interface IParameterFieldRangeValue
beginValue
- The lower-bound value as an Object
.public void setEndValue(java.lang.Object endValue)
IParameterFieldRangeValue
Returns the upper-bound value of the range.
Use the IParameterFieldRangeValue.getBeginValue()
method to determine
the lower-bound value.
setEndValue
in interface IParameterFieldRangeValue
endValue
- The upper-bound value as an Object
.public void setLowerBoundType(RangeValueBoundType lowerBoundType)
IParameterFieldRangeValue
Sets how the lower bound of the range is treated. This method can also be used to specify that the range has no lower bound.
setLowerBoundType
in interface IParameterFieldRangeValue
lowerBoundType
- How the lower bound of the range is treated
as a RangeValueBoundType
Object
.public void setUpperBoundType(RangeValueBoundType upperBoundType)
IParameterFieldRangeValue
Sets how the upper bound of the range is treated. This method can also be used to specify that the range has no upper bound.
setUpperBoundType
in interface IParameterFieldRangeValue
upperBoundType
- How the upper bound of the range is treated
as a RangeValueBoundType
object.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |