net.sf.mpxj
Class GroupClause

java.lang.Object
  net.sf.mpxj.GroupClause

public final class GroupClause
extends Object

This class represents a clause from a definition of a group.

Constructor Summary

GroupClause()

Method Summary

boolean	getAscending() Retrieve a flag indicating that values are grouped in ascending order.
Color	getCellBackgroundColor() Retrieves the background color.
FieldType	getField() Retrieve the grouping field.
FontStyle	getFont() Retrieve the font.
Object	getGroupInterval() Retrieve the group interval.
int	getGroupOn() Retrieves the group on value.
BackgroundPattern	getPattern() Retrieves the pattern.
Object	getStartAt() Retrieves the "start at" value.
void	setAscending(boolean ascending) Sets a flag indicating that values are grouped in ascending order.
void	setCellBackgroundColor(Color color) Sets the background color.
void	setField(FieldType field) Set the grouping field.
void	setFont(FontStyle font) Retrieve the font.
void	setGroupInterval(Object groupInterval) Sets the group interval.
void	setGroupOn(int groupOn) Sets the group on value.
void	setPattern(BackgroundPattern pattern) Sets the pattern.
void	setStartAt(Object startAt) Sets the "start at" value.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GroupClause

public GroupClause()

Method Detail

getAscending

public boolean getAscending()

Retrieve a flag indicating that values are grouped in ascending order.

Returns:

boolean flag

setAscending

public void setAscending(boolean ascending)

Sets a flag indicating that values are grouped in ascending order.

Parameters:

ascending - boolean flag

getCellBackgroundColor

public Color getCellBackgroundColor()

Retrieves the background color.

Returns:

background color

setCellBackgroundColor

public void setCellBackgroundColor(Color color)

Sets the background color.

Parameters:

color - background color.

getField

public FieldType getField()

Retrieve the grouping field.

Returns:

grouping field

setField

public void setField(FieldType field)

Set the grouping field.

Parameters:

field - grouping field

getFont

public FontStyle getFont()

Retrieve the font.

Returns:

font

setFont

public void setFont(FontStyle font)

Retrieve the font.

Parameters:

font - font

getGroupInterval

public Object getGroupInterval()

Retrieve the group interval.

Returns:

group interval

setGroupInterval

public void setGroupInterval(Object groupInterval)

Sets the group interval.

Parameters:

groupInterval - group interval

getGroupOn

public int getGroupOn()

Retrieves the group on value.

Returns:

group on value

setGroupOn

public void setGroupOn(int groupOn)

Sets the group on value.

Parameters:

groupOn - group on value

getPattern

public BackgroundPattern getPattern()

Retrieves the pattern.

Returns:

pattern

setPattern

public void setPattern(BackgroundPattern pattern)

Sets the pattern.

Parameters:

pattern - pattern

getStartAt

public Object getStartAt()

Retrieves the "start at" value.

Returns:

"start at" value

setStartAt

public void setStartAt(Object startAt)

Sets the "start at" value.

Parameters:

startAt - "start at" value

toString

public String toString()

Overrides:

toString in class Object