|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.Field
com.crystaldecisions.sdk.occa.report.data.GroupNameField
public class GroupNameField
This object implements a group name field.
By default, the group name field has the same values as
the group's condition field. It is not necessary to
use a controller to create the group name field.
As long as a group is defined, the SDK can accept
it in the RowsetController
and
ReportDefController
.
Using the RowsetController
, you can use the data fields
of the RowsetMetaData
object to fetch the group's value.
Using ReportDefController
, you can add a FieldObject
.
Then you can bind the GroupNameField
to this FieldObject
by
assigning its FormulaForm
to the FieldObject's DataSource
.
This FieldObject
should be added to the sections in the group
header and group footer areas of the report.
When possible, use the IGroupNameField
interface to manipulate this object.
Constructor Summary | |
---|---|
GroupNameField()
|
|
GroupNameField(IGroupNameField src)
|
Method Summary | |
---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
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. |
void |
doControllerModification(java.lang.Object newObject)
|
void |
enumerateMembers(IMemberVisitor visitor)
|
java.lang.String |
getFormulaForm()
Returns the name of the field as it will be used in a formula. |
IGroup |
getGroup()
Returns the group whose name will be used in the group name field. |
boolean |
getIsPrintTime()
|
FieldKind |
getKind()
Returns what kind of field this is. |
java.lang.String |
getLongName(java.util.Locale locale)
Returns the fully qualified name of the field. |
java.lang.String |
getShortName(java.util.Locale locale)
Returns the short name of the field. |
boolean |
hasContent(java.lang.Object srcGroupNameField)
|
boolean |
isDirectlyControllable()
|
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 |
setGroup(IGroup group)
Sets the group whose name will be used in the group name field. |
Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Field |
---|
endElement, getAttributes, getControllableMixin, getDescription, getDisplayName, getHeadingText, getIsRecurring, getLength, getName, getType, setAttributes, setDescription, setHeadingText, setLength, setName, setType, 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.IField |
---|
getDescription, getDisplayName, getHeadingText, getIsRecurring, getLength, getName, getType, setDescription, setHeadingText, setLength, setName, setType |
Constructor Detail |
---|
public GroupNameField(IGroupNameField src)
public GroupNameField()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
clone
in class Field
public void copyTo(java.lang.Object destObject, boolean deepCopy)
copyTo
in class Field
public 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.
createMember
in class Field
public java.lang.String getFormulaForm()
IField
Returns the name of the field as it will be used in a formula. This is a unique identifier to avoid ambiguity in formula code. It is the same value as the one used in the CRW formula editor.
getFormulaForm
in interface IField
getFormulaForm
in class Field
String
containing the name of the field as it will be used in a
formula.public IGroup getGroup()
IGroupNameField
Returns the group whose name will be used in the group name field.
getGroup
in interface IGroupNameField
IGroup
interface.public FieldKind getKind()
IField
Returns what kind of field this is. Do not confuse this property with Type. Kind identifies what sort of report field this is, while Type identifies what the field is composed of. For example, a bitmap, string, chart, number, date, and so on.
getKind
in interface IField
String
that specifies what kind of field this is.public boolean getIsPrintTime()
getIsPrintTime
in class Field
public java.lang.String getLongName(java.util.Locale locale)
IField
Returns the fully qualified name of the field.
getLongName
in interface IField
getLongName
in class Field
locale
- The locale that will be used to localize the field.
String
containing the fully qualified name of the field.public java.lang.String getShortName(java.util.Locale locale)
IField
Returns the short name of the field.
getShortName
in interface IField
getShortName
in class Field
locale
- The locale that will be used to localize the field name.
String
containing the short name of the field.public boolean hasContent(java.lang.Object srcGroupNameField)
hasContent
in class Field
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
Field
For internal use only.
readElement
in class Field
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class Field
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
save
in class Field
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
Field
For internal use only.
saveContents
in class Field
java.io.IOException
public void setGroup(IGroup group)
IGroupNameField
Sets the group whose name will be used in the group name field.
setGroup
in interface IGroupNameField
group
- The IGroup
interface.public void doControllerModification(java.lang.Object newObject)
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |