i-net Clear Reports

com.inet.report
Interface GeneralProperties

All Known Implementing Classes:
AbstractFontElement, AbstractLineElement, AbstractPictureElement, AbstractValueElement, Box, Chart2, CrossTab, CrossTabCell, CrossTabColumn, CrossTabRow, DatabasePicture, Element, FieldElement, FieldPart, JavaBean, Line, Paragraph, Picture, SignatureForm, Subreport, Text, TextPart

public interface GeneralProperties

Interface for all elements that can be inserted into sections.

This class is part of the RDC.


Field Summary
static int ALIGN_HORIZONTAL_CENTER
          The horizontal alignment will be centered.
static int ALIGN_HORIZONTAL_DEFAULT
          The horizontal alignment will be the system default, i.e.
static int ALIGN_HORIZONTAL_JUSTIFIED
          The horizontal alignment will be justified.
static int ALIGN_HORIZONTAL_LEFT
          The horizontal alignment will be left aligned.
static int ALIGN_HORIZONTAL_RIGHT
          The horizontal alignment will be right.
 
Method Summary
 int getCanGrowCount()
          Returns the value of the property 'can grow count'.
 FormulaField getCanGrowFormula()
          Returns the formula of the property 'can grow'.
 int getHorAlign()
          Returns the value of the property 'horizontal alignment'.
 FormulaField getHorAlignFormula()
          Returns the formula for the property 'horizontal alignment'.
 FormulaField getKeepTogetherFormula()
          Returns the formula for the property 'keep together'.
 FormulaField getSuppressFormula()
          Returns the formula for the property 'suppress'.
 FormulaField getSuppressIfDuplicatedFormula()
          Returns the formula for the property 'suppress if duplicated'.
 java.lang.String getToolTipsText()
          Returns the value of the property 'tool tips text'.
 FormulaField getToolTipsTextFormula()
          Returns the formula of the property 'tool tips text'.
 boolean isCanGrow()
          Returns the value of the property 'can grow'.
 boolean isKeepTogether()
          Returns the value of the property 'keep together'.
 boolean isSuppress()
          Returns the value of the property 'suppress'.
 boolean isSuppressIfDuplicated()
          Returns the value of the property 'suppress if duplicated'.
 void setCanGrow(boolean canGrow)
          Sets the value of the property 'can grow'.
 void setCanGrowCount(int newValue)
          Sets the value of the property 'can grow count'.
 void setCanGrowFormula(FormulaField newFormula)
          Sets the formula for the property 'can grow'.
 void setHorAlign(int value)
          Sets the value of the property 'horizontal alignment'.
 void setHorAlignFormula(FormulaField newFormula)
          Sets the formula for the property 'horizontal alignment'.
 void setKeepTogether(boolean newValue)
          Sets the value of the property 'keep together'.
 void setKeepTogetherFormula(FormulaField newFormula)
          Sets the formula for the property 'keep together'.
 void setSuppress(boolean newValue)
          Sets the value of the property 'suppress'.
 void setSuppressFormula(FormulaField newFormula)
          Sets the formula for the property 'suppress'.
 void setSuppressIfDuplicated(boolean newValue)
          Sets the value of the property 'suppress if duplicated'.
 void setSuppressIfDuplicatedFormula(FormulaField newFormula)
          Sets the formula for the property 'suppress if duplicated'.
 void setToolTipsText(java.lang.String newValue)
          Sets the value of the property 'tool tips text'.
 void setToolTipsTextFormula(FormulaField newFormula)
          Sets the formula for the property 'tool tips text'.
 

Field Detail

ALIGN_HORIZONTAL_DEFAULT

static final int ALIGN_HORIZONTAL_DEFAULT
The horizontal alignment will be the system default, i.e. ALIGN_HORIZONTAL_LEFT

Since:
7.0
See Also:
Constant Field Values

ALIGN_HORIZONTAL_LEFT

static final int ALIGN_HORIZONTAL_LEFT
The horizontal alignment will be left aligned.

Since:
7.0
See Also:
Constant Field Values

ALIGN_HORIZONTAL_CENTER

static final int ALIGN_HORIZONTAL_CENTER
The horizontal alignment will be centered.

Since:
7.0
See Also:
Constant Field Values

ALIGN_HORIZONTAL_RIGHT

static final int ALIGN_HORIZONTAL_RIGHT
The horizontal alignment will be right.

Since:
7.0
See Also:
Constant Field Values

ALIGN_HORIZONTAL_JUSTIFIED

static final int ALIGN_HORIZONTAL_JUSTIFIED
The horizontal alignment will be justified.

Since:
7.0
See Also:
Constant Field Values
Method Detail

setSuppressIfDuplicated

void setSuppressIfDuplicated(boolean newValue)
Sets the value of the property 'suppress if duplicated'.
If this property is enabled values of the field that are duplicated will not be printed.

Parameters:
newValue - The new value of the property 'suppress if duplicated'.

isSuppressIfDuplicated

boolean isSuppressIfDuplicated()
Returns the value of the property 'suppress if duplicated'.
If this property is enabled, values of the field that are duplicated will not be printed.

Returns:
The value of the property 'suppress if duplicated'.
Since:
7.0

setSuppressIfDuplicatedFormula

void setSuppressIfDuplicatedFormula(FormulaField newFormula)
Sets the formula for the property 'suppress if duplicated'.
If this property is enabled, values of the field that are duplicated will not be printed.

Parameters:
newFormula - The new formula for the property 'suppress if duplicated'.

getSuppressIfDuplicatedFormula

FormulaField getSuppressIfDuplicatedFormula()
Returns the formula for the property 'suppress if duplicated'.
If this property is enabled, values of the field that are duplicated will not be printed.

Returns:
FormulaField The formula for the property 'suppress if duplicated'.

getCanGrowCount

int getCanGrowCount()
Returns the value of the property 'can grow count'.
This property gives the maximum numbers of lines that a Text or a FieldElement can grow. Give 0 if you do not want to set a limit.

Returns:
The current value of the property 'can grow count'.

setCanGrowCount

void setCanGrowCount(int newValue)
Sets the value of the property 'can grow count'.
This property gives the maximum numbers of lines that a Text or a FieldElement can grow. Give 0 if you do not want to set a limit.

Parameters:
newValue - The new value of the property 'can grow count'.

getHorAlignFormula

FormulaField getHorAlignFormula()
Returns the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.

Returns:
FormulaField The formula for the property 'horizontal alignment'.

setHorAlignFormula

void setHorAlignFormula(FormulaField newFormula)
Sets the formula for the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.

Parameters:
newFormula - The new formula for the property 'horizontal alignment'. The result of the formula should be in range from 0 to 4.
See Also:
ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_RIGHT, ALIGN_HORIZONTAL_JUSTIFIED

setHorAlign

void setHorAlign(int value)
Sets the value of the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.

Parameters:
value - The new value of the property 'horizontal alignment'.
See Also:
ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_RIGHT, ALIGN_HORIZONTAL_JUSTIFIED

getHorAlign

int getHorAlign()
Returns the value of the property 'horizontal alignment'.
Possible alignments are default, left, center, right or justified.

Returns:
Possible return values are default, left, center, right or justified.
See Also:
ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_RIGHT, ALIGN_HORIZONTAL_JUSTIFIED

isCanGrow

boolean isCanGrow()
Returns the value of the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.

Returns:
The value of the property 'can grow'.
Since:
7.0

setCanGrow

void setCanGrow(boolean canGrow)
Sets the value of the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.

Parameters:
canGrow - The new value of the property 'can grow'

getCanGrowFormula

FormulaField getCanGrowFormula()
Returns the formula of the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.

Returns:
FormulaField The formula of the property 'can grow'.

setCanGrowFormula

void setCanGrowFormula(FormulaField newFormula)
Sets the formula for the property 'can grow'.
If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.

Parameters:
newFormula - The new formula for the property 'can grow'.

isKeepTogether

boolean isKeepTogether()
Returns the value of the property 'keep together'.
If this property is enabled, the element will not printed over more than one page. If no space is available on this page, it will be printed on the next. Using this property for sections all elements will be printed on one page.

Returns:
The current value of the property 'keep together'.
Since:
7.0

setKeepTogether

void setKeepTogether(boolean newValue)
Sets the value of the property 'keep together'.
If this property is enabled, the element will not printed over more than one page. If no space is available on this page, it will be printed on the next. Using this property for sections all elements will be printed on one page.

Parameters:
newValue - The new value of the property 'keep together'.

getKeepTogetherFormula

FormulaField getKeepTogetherFormula()
Returns the formula for the property 'keep together'.
If this property is enabled, the element will not printed over more than one page. If no space is available on this page, it will be printed on the next. Using this property for sections all elements will be printed on one page.

Returns:
FormulaField The formula for the property 'keep together'.

setKeepTogetherFormula

void setKeepTogetherFormula(FormulaField newFormula)
Sets the formula for the property 'keep together'.
If this property is enabled, the element will not printed over more than one page. If no space is available on this page, it will be printed on the next. Using this property for sections all elements will be printed on one page.

Parameters:
newFormula - The new formula for the property 'keep together'.

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'.

isSuppress

boolean isSuppress()
Returns the value of the property 'suppress'.
Set this property if you do not want the section to print, but you do not 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'.

getSuppressFormula

FormulaField getSuppressFormula()
Returns the formula for the property 'suppress'.

Returns:
FormulaField The formula for the property 'suppress'.
See Also:
setSuppress(boolean), setSuppressFormula(com.inet.report.FormulaField)

getToolTipsText

java.lang.String getToolTipsText()
Returns the value of the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.

Returns:
The value of the property 'tool tips text'.

setToolTipsText

void setToolTipsText(java.lang.String newValue)
Sets the value of the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.

Parameters:
newValue - The new value of the property 'tool tips text'.

getToolTipsTextFormula

FormulaField getToolTipsTextFormula()
Returns the formula of the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.

Returns:
FormulaField The formula of the property 'tool tips text'.
Since:
6.0

setToolTipsTextFormula

void setToolTipsTextFormula(FormulaField newFormula)
Sets the formula for the property 'tool tips text'.
The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.

Parameters:
newFormula - The new formula for the property 'tool tips text'.

i-net Clear Reports

Copyright © 1999-2015 by i-net software GmbH