com.crystaldecisions.sdk.occa.report.data
Class GroupNameField

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.Field
      extended by com.crystaldecisions.sdk.occa.report.data.GroupNameField
All Implemented Interfaces:
IField, IGroupNameField, IClone

public class GroupNameField
extends Field
implements IGroupNameField

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

GroupNameField

public GroupNameField(IGroupNameField src)

GroupNameField

public GroupNameField()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class Field

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class Field

createMember

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.

Overrides:
createMember in class Field

getFormulaForm

public java.lang.String getFormulaForm()
Description copied from interface: 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.

Specified by:
getFormulaForm in interface IField
Overrides:
getFormulaForm in class Field
Returns:
A String containing the name of the field as it will be used in a formula.

getGroup

public IGroup getGroup()
Description copied from interface: IGroupNameField

Returns the group whose name will be used in the group name field.

Specified by:
getGroup in interface IGroupNameField
Returns:
The IGroup interface.

getKind

public FieldKind getKind()
Description copied from interface: 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.

Specified by:
getKind in interface IField
Returns:
A String that specifies what kind of field this is.

getIsPrintTime

public boolean getIsPrintTime()
Overrides:
getIsPrintTime in class Field

getLongName

public java.lang.String getLongName(java.util.Locale locale)
Description copied from interface: IField

Returns the fully qualified name of the field.

Specified by:
getLongName in interface IField
Overrides:
getLongName in class Field
Parameters:
locale - The locale that will be used to localize the field.
Returns:
A String containing the fully qualified name of the field.

getShortName

public java.lang.String getShortName(java.util.Locale locale)
Description copied from interface: IField

Returns the short name of the field.

Specified by:
getShortName in interface IField
Overrides:
getShortName in class Field
Parameters:
locale - The locale that will be used to localize the field name.
Returns:
A String containing the short name of the field.

hasContent

public boolean hasContent(java.lang.Object srcGroupNameField)
Overrides:
hasContent in class Field

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
Description copied from class: Field

For internal use only.

Overrides:
readElement in class Field

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Overrides:
save in class Field
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Overrides:
save in class Field
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Description copied from class: Field

For internal use only.

Overrides:
saveContents in class Field
Throws:
java.io.IOException

setGroup

public void setGroup(IGroup group)
Description copied from interface: IGroupNameField

Sets the group whose name will be used in the group name field.

Specified by:
setGroup in interface IGroupNameField
Parameters:
group - The IGroup interface.

doControllerModification

public void doControllerModification(java.lang.Object newObject)

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)