com.crystaldecisions.sdk.occa.report.definition
Class CrossTabGridLineOptions

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.CrossTabGridLineOptions
All Implemented Interfaces:
ICrossTabGridLineOptions, IClone

public class CrossTabGridLineOptions
extends java.lang.Object
implements ICrossTabGridLineOptions

This class holds formatting options of grid lines used in cross-tab objects. Options include line style, color, width and "is visible". These options are saved with individual crosstab objects and do not affect any other crosstabs.

See Also:
ICrossTabGridLineFormattingInfo#setGridLineOptionsByType(CrossTabGridLineType, ICrossTabGridLineOptions)

Constructor Summary
CrossTabGridLineOptions()
          Creates a new CrossTabGridLineOptions object.
CrossTabGridLineOptions(ICrossTabGridLineOptions src)
          Copies the given ICrossTabGridLineOptions object.
CrossTabGridLineOptions(LineStyle lineStyle, java.awt.Color color, int width, boolean isDraw)
          Creates a new CrossTabGridLineOptions object, initialized with the given line style, color, width and "is visible" properties.
 
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)
          For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
          For internal use only.
 java.awt.Color getColor()
          Gets the grid line's color.
 ControllableMixin getControllableMixin()
          For internal use only.
 boolean getIsDraw()
          Gets whether the grid line is visible.
 LineStyle getLineStyle()
          Gets the grid line's line style.
 int getWidth()
          Gets the grid line's width.
 boolean hasContent(java.lang.Object otherOptions)
           
 boolean isDirectlyControllable()
          For internal use only.
 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 setColor(java.awt.Color color)
          Sets the grid line's color.
 void setIsDraw(boolean isDraw)
          Sets whether the grid line is visible.
 void setLineStyle(LineStyle lineStyle)
          Sets the grid line's line style.
 void setWidth(int width)
          Sets the grid line's width.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CrossTabGridLineOptions

public CrossTabGridLineOptions()
Creates a new CrossTabGridLineOptions object.


CrossTabGridLineOptions

public CrossTabGridLineOptions(LineStyle lineStyle,
                               java.awt.Color color,
                               int width,
                               boolean isDraw)
Creates a new CrossTabGridLineOptions object, initialized with the given line style, color, width and "is visible" properties.

Parameters:
lineStyle - the line style to use
color - the line's colour
width - the line's width
isDraw - true if the line is visible, false otherwise

CrossTabGridLineOptions

public CrossTabGridLineOptions(ICrossTabGridLineOptions src)
Copies the given ICrossTabGridLineOptions object. This constructor makes a deep copy of the src object.

Parameters:
src - the object to copy
Method Detail

getLineStyle

public LineStyle getLineStyle()
Description copied from interface: ICrossTabGridLineOptions
Gets the grid line's line style.

Specified by:
getLineStyle in interface ICrossTabGridLineOptions
Returns:
the grid line's style as a com.crystaldecisions.sdk.occa.report.definition.LineStyle

setLineStyle

public void setLineStyle(LineStyle lineStyle)
Description copied from interface: ICrossTabGridLineOptions
Sets the grid line's line style.

Specified by:
setLineStyle in interface ICrossTabGridLineOptions
Parameters:
lineStyle - the grid line's style as a com.crystaldecisions.sdk.occa.report.definition.LineStyle

getColor

public java.awt.Color getColor()
Description copied from interface: ICrossTabGridLineOptions
Gets the grid line's color.

Specified by:
getColor in interface ICrossTabGridLineOptions
Returns:
the grid line's color as a java.awt.Color object

setColor

public void setColor(java.awt.Color color)
Description copied from interface: ICrossTabGridLineOptions
Sets the grid line's color.

Specified by:
setColor in interface ICrossTabGridLineOptions
Parameters:
color - the grid line's color as a java.awt.Color object

getWidth

public int getWidth()
Description copied from interface: ICrossTabGridLineOptions
Gets the grid line's width.

Specified by:
getWidth in interface ICrossTabGridLineOptions
Returns:
the int value of the grid line's width

setWidth

public void setWidth(int width)
Description copied from interface: ICrossTabGridLineOptions
Sets the grid line's width.

Specified by:
setWidth in interface ICrossTabGridLineOptions
Parameters:
width - the int value of the grid line's width

getIsDraw

public boolean getIsDraw()
Description copied from interface: ICrossTabGridLineOptions
Gets whether the grid line is visible.

Specified by:
getIsDraw in interface ICrossTabGridLineOptions
Returns:
true if the grid line is visible, false if it is not

setIsDraw

public void setIsDraw(boolean isDraw)
Description copied from interface: ICrossTabGridLineOptions
Sets whether the grid line is visible.

Specified by:
setIsDraw in interface ICrossTabGridLineOptions
Parameters:
isDraw - true if the grid line is visible, false if it is not

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

hasContent

public boolean hasContent(java.lang.Object otherOptions)

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.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
For internal use only.


readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
For internal use only.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Throws:
java.io.IOException

save

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

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
For internal use only.

Throws:
java.io.IOException

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
For internal use only.


doControllerModification

public void doControllerModification(java.lang.Object newObject)
For internal use only.


getControllableMixin

public ControllableMixin getControllableMixin()
For internal use only.


isDirectlyControllable

public boolean isDirectlyControllable()
For internal use only.


enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)
For internal use only.