LineProperties (i-net Clear Reports)

All Known Implementing Classes:

AbstractLineElement, Box, Line
```
public interface LineProperties
```
Interface for elements that draws lines across multiple sections.

This class is part of the RDC.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Section`	`getEndSection()` Gets the value of the property 'end section'.
`int`	`getForeColor()` Gets the fore color of the element.
`int`	`getHeight()` Gets the height of an element.
`int`	`getLineStyle()` Returns the value of the property 'line style', with one of the different line styles single line, dashed line or dotted line.
`int`	`getLineWidth()` Returns the value of the property 'line width'.
`FormulaField`	`getSuppressFormula()` Returns the formula for the property 'suppress'.
`int`	`getWidth()` Gets the width of an element.
`int`	`getX()` Gets the x position of the left upper corner of the element in the report.
`int`	`getX2()` Gets the x position of the element in the end section, if the element does not end in the same section as it begins.
`int`	`getY()` Gets the y position of the left upper corner of the element in the report.
`int`	`getY2()` Gets the x position of the element in the end section, if the element does not end in the same section as it begins.
`boolean`	`isExtendToBottomOfSectionWhenPrinting()` Gets the value of the property 'extend to bottom of section when printing'.
`boolean`	`isSuppress()` Returns the value of the property 'suppress'.
`void`	`setEndSection(Section newValue)` Sets the value of the property 'end section'.
`void`	`setExtendToBottomOfSectionWhenPrinting(boolean b)` Sets the value of the property 'extend to bottom of section when printing'.
`void`	`setForeColor(int newValue)` Sets the value of the property 'fore color'.
`void`	`setHeight(int height)` Sets the height of an element.
`void`	`setLineStyle(int newValue)` Sets the value of the property 'line style' with one of the different line styles single line, dashed line or dotted line.
`void`	`setLineWidth(int lineWidth)` Sets the value of the property 'line width'.
`void`	`setSuppress(boolean newValue)` Sets the value of the property 'suppress'.
`void`	`setSuppressFormula(FormulaField newFormula)` Sets the formula for the property 'suppress'.
`void`	`setWidth(int width)` Sets the width of an element.
`void`	`setX(int x)` Sets the x position of the left upper corner of the element in the report.
`void`	`setX2(int x2)` Sets the x position of the element in the end section, if the element does not end in the same section as it begins.
`void`	`setY(int y)` Sets the y position of the left upper corner of the element in the report.
`void`	`setY2(int y2)` Sets the y position of the element in the end section, if the element does not end in the same section as it begins.

- Method Detail
  - setForeColor
```
void setForeColor(int newValue)
```
    Sets the value of the property 'fore color'. This property sets the fore color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class CoderXML. In most cases this color represents the border color. More information about the usage of colors in RDC can be found in the RDC documentation.
    
    Parameters:
    
    newValue - the new Value for the property 'fore color'.
    
    Since:
    
    7.0
    
    See Also:
    
    RDC.toCcColor(Color), ColorUtils.toJavaColor(int)
  - getForeColor
```
int getForeColor()
```
    Gets the fore color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class CoderXML. In most cases this color represents the border color. More information about the usage of colors in RDC can be found in the RDC documentation.
    
    Returns:
    
    The 'fore color' value of the element.
    
    Since:
    
    7.0
    
    See Also:
    
    RDC.toCcColor(Color), ColorUtils.toJavaColor(int)
  - setSuppress
```
void setSuppress(boolean newValue)
```
    Sets the value of the property 'suppress'. Set this property if you do not want the section to print, but you dont't want to keep the section content available for drill down. Drill Down is not supported yet.
    
    Parameters:
    
    newValue - The new value of the property 'suppress'.
    
    Since:
    
    7.0
  - isSuppress
```
boolean isSuppress()
```
    Returns the value of the property 'suppress'. Set this property if you do not want the section to print, but you dont't want to keep the section content available for drill down. Drill Down is not supported yet.
    
    Returns:
    
    The value of the property 'suppress'.
    
    Since:
    
    7.0
  - setSuppressFormula
```
void setSuppressFormula(FormulaField newFormula)
```
    Sets the formula for the property 'suppress'. Use this property to change the visibility of the element when printing dynamically.
    
    Parameters:
    
    newFormula - The new formula for the property 'suppress'.
    
    Since:
    
    7.0
  - getSuppressFormula
```
FormulaField getSuppressFormula()
```
    Returns the formula for the property 'suppress'.
    
    Returns:
    
    FormulaField The formula for the property 'suppress'.
    
    Since:
    
    7.0
    
    See Also:
    
    setSuppress(boolean), setSuppressFormula(com.inet.report.FormulaField)
  - getEndSection
```
Section getEndSection()
```
    Gets the value of the property 'end section'. When the line should span some sections, you have to specify the end-section of the line.
    
    Returns:
    
    The section in that the line ends if the line goes across more than one section.
    
    Since:
    
    7.0
  - setEndSection
```
void setEndSection(Section newValue)
```
    Sets the value of the property 'end section'. When the line should span some sections, you have to specify the end-section of the line.
    
    Parameters:
    
    newValue - The section in that the line should ends, if the line should go accross more than one section.
    
    Since:
    
    7.0
  - setExtendToBottomOfSectionWhenPrinting
```
void setExtendToBottomOfSectionWhenPrinting(boolean b)
```
    Sets the value of the property 'extend to bottom of section when printing'. If this property is true, the vertical line will extend up to the end of the section when printing.
    
    Parameters:
    
    b - true if the line should be extended, otherwise false.
    
    Since:
    
    7.0
  - isExtendToBottomOfSectionWhenPrinting
```
boolean isExtendToBottomOfSectionWhenPrinting()
```
    Gets the value of the property 'extend to bottom of section when printing'. If this property is true, the vertical line will extend up to the end of the section when printing.
    
    Returns:
    
    true if the line will be extended, otherwise false.
    
    Since:
    
    7.0
  - setLineWidth
```
void setLineWidth(int lineWidth)
```
    Sets the value of the property 'line width'. Use it to set the width of the line. See units in rdc.
    
    Parameters:
    
    lineWidth - The new value of the property 'line width' in twips.
    
    Since:
    
    7.0
  - getLineWidth
```
int getLineWidth()
```
    Returns the value of the property 'line width'. Use it to get the width of the line. See units in rdc.
    
    Returns:
    
    The current value of the property 'line width' in twips.
    
    Since:
    
    7.0
  - setLineStyle
```
void setLineStyle(int newValue)
```
    Sets the value of the property 'line style' with one of the different line styles single line, dashed line or dotted line.
    
    Parameters:
    
    newValue - The new value of the property 'line style'.
    
    Since:
    
    7.0
    
    See Also:
    
    BorderPropertiesConstants.NO_LINE, BorderPropertiesConstants.LINE_STYLE_SINGLE, BorderPropertiesConstants.LINE_STYLE_DOUBLE, BorderPropertiesConstants.LINE_STYLE_DASHED, BorderPropertiesConstants.LINE_STYLE_DOTTED
  - getLineStyle
```
int getLineStyle()
```
    Returns the value of the property 'line style', with one of the different line styles single line, dashed line or dotted line.
    
    Returns:
    
    The current value of the property 'line style'.
    
    Since:
    
    7.0
    
    See Also:
    
    BorderPropertiesConstants.NO_LINE, BorderPropertiesConstants.LINE_STYLE_SINGLE, BorderPropertiesConstants.LINE_STYLE_DOUBLE, BorderPropertiesConstants.LINE_STYLE_DASHED, BorderPropertiesConstants.LINE_STYLE_DOTTED
  - setX2
```
void setX2(int x2)
```
    Sets the x position of the element in the end section, if the element does not end in the same section as it begins. The unit is in twips.
    
    Parameters:
    
    x2 - The x position in twips.
    
    Since:
    
    7.0
  - getX2
```
int getX2()
```
    Gets the x position of the element in the end section, if the element does not end in the same section as it begins. The unit is in twips.
    
    Returns:
    
    The x position in the end section in twips.
    
    Since:
    
    7.0
  - setY2
```
void setY2(int y2)
```
    Sets the y position of the element in the end section, if the element does not end in the same section as it begins.
    
    Parameters:
    
    y2 - The y position in twips.
    
    Since:
    
    7.0
  - getY2
```
int getY2()
```
    Gets the x position of the element in the end section, if the element does not end in the same section as it begins.
    
    Returns:
    
    The x position in the end section in twips.
    
    Since:
    
    7.0
  - setX
```
void setX(int x)
```
    Sets the x position of the left upper corner of the element in the report. Use the 'object x position' property the adjust the element position from the left side margin. The unit is in twips.
    
    Parameters:
    
    x - The x position in twips.
    
    Since:
    
    7.0
  - getX
```
int getX()
```
    Gets the x position of the left upper corner of the element in the report. Use the 'object x position' property the adjust the element position from the left side margin. The unit is in twips.
    
    Returns:
    
    The x position in twips.
    
    Since:
    
    7.0
  - setY
```
void setY(int y)
```
    Sets the y position of the left upper corner of the element in the report. Use the 'object y position' property the adjust the element position from the top margin. The unit is in twips.
    
    Parameters:
    
    y - The y position in twips.
    
    Since:
    
    7.0
  - getY
```
int getY()
```
    Gets the y position of the left upper corner of the element in the report. Use the 'object y position' property the adjust the element position from the top margin. The unit is in twips.
    
    Returns:
    
    The y position in twips.
    
    Since:
    
    7.0
  - setWidth
```
void setWidth(int width)
```
    Sets the width of an element. Use the 'element width' property to change the width of the element. The unit is in twips.
    
    Parameters:
    
    width - The width in twips.
    
    Since:
    
    7.0
  - getWidth
```
int getWidth()
```
    Gets the width of an element. Use the 'element width' property to change the width of the element. The unit is in twips.
    
    Returns:
    
    The width in twips.
    
    Since:
    
    7.0
  - setHeight
```
void setHeight(int height)
```
    Sets the height of an element. Use the 'element height' property to change the height of the element. The unit is in twips.
    
    Parameters:
    
    height - The height in twips.
    
    Since:
    
    7.0
  - getHeight
```
int getHeight()
```
    Gets the height of an element. Use the 'element height' property to change the height of the element. The unit is in twips.
    
    Returns:
    
    The height in twips.
    
    Since:
    
    7.0

Interface LineProperties

Method Summary

Method Detail

setForeColor

getForeColor

setSuppress

isSuppress

setSuppressFormula

getSuppressFormula

getEndSection

setEndSection

setExtendToBottomOfSectionWhenPrinting

isExtendToBottomOfSectionWhenPrinting

setLineWidth

getLineWidth

setLineStyle

getLineStyle

setX2

getX2

setY2

getY2

setX

getX

setY

getY

setWidth

getWidth

setHeight

getHeight