com.businessobjects.rebean.wi
Interface FreeCell

All Superinterfaces:
Alertable, Attachable, Cell, Decoration, Position, ReportElement, TreeNode, Unit

public interface FreeCell
extends Cell

Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.

A Cell holding a text value, not linked to any report expression.

See Also:
ReportBody.createFreeCell(String), SectionContainer.createFreeCell(String)

Method Summary
 boolean getContainsMacro()
          Deprecated. The [page] and [pages] macros are no longer supported by RESDK.
 java.lang.String getValue()
          Returns the current text value contained in the FreeCell.
 void setContainsMacro(boolean b)
          Deprecated. The [page] and [pages] macros are no longer supported by RESDK.
 void setValue(java.lang.String value)
          Changes the current text value
 ReportCell toReportCell()
          Turns a FreeCell into a ReportCell.
 
Methods inherited from interface com.businessobjects.rebean.wi.Cell
avoidPageBreak, avoidPageBreak, estimateMinimalHeight, getContentType, getHeight, getHorizontalPadding, getVerticalPadding, getWidth, isAutoFitHeight, isAutoFitWidth, isShowWhenEmpty, repeatOnEveryPage, repeatOnEveryPage, setAutoFitHeight, setAutoFitWidth, setContentType, setHeight, setHorizontalPadding, setShowWhenEmpty, setVerticalPadding, setWidth
 
Methods inherited from interface com.businessobjects.rebean.wi.ReportElement
getFather, getID, getReportElement, getReportElement, getReportElementCount
 
Methods inherited from interface com.businessobjects.rebean.wi.TreeNode
getChildAt, getChildCount, getIndex, getParent, isLeaf
 
Methods inherited from interface com.businessobjects.rebean.wi.Decoration
getAlignment, getAttributes, getBackgroundAlignment, getFont, setAlignment, setAttributes, setBackgroundAlignment, setFont
 
Methods inherited from interface com.businessobjects.rebean.wi.Attachable
deleteAttachment, getAttachTo, getHAttachTo, getHorizontalAnchor, getVAttachTo, getVerticalAnchor, setAttachTo, setAttachTo
 
Methods inherited from interface com.businessobjects.rebean.wi.Position
getX, getY, setLocation, setX, setY
 
Methods inherited from interface com.businessobjects.rebean.wi.Unit
getUnit, setUnit
 
Methods inherited from interface com.businessobjects.rebean.wi.Alertable
getAlerters
 

Method Detail

getValue

java.lang.String getValue()
Returns the current text value contained in the FreeCell.

Returns:
the current text value

setValue

void setValue(java.lang.String value)
Changes the current text value

Parameters:
value - the new text value
Throws:
java.lang.NullPointerException - when value is null

getContainsMacro

boolean getContainsMacro()
Deprecated. The [page] and [pages] macros are no longer supported by RESDK.

The [page] and [pages] macros will only be evaluated on legacy documents at open time. The deprecated API still works but sends back a report error.

Cells containing these 2 macros will change type from FreeCell to ReportCell with the function page().

Custom applications that create document on the fly using getContainsMacro() and setContainsMacro() need to have their behavior changed to the following:

  1. Create a ReportCell in place of a FreeCell.
  2. Add the function page() or pages() to the ReportCell

Note: Attention, these formulae are localized

Original API Documentation below.

Checks if the contents of this cell should be checked for macros or not.

Valid macros are:

[page]
The current page number
[pages]
The total number of pages in the report

Returns:
true when the cell should be checked for macros

setContainsMacro

void setContainsMacro(boolean b)
Deprecated. The [page] and [pages] macros are no longer supported by RESDK.

The [page] and [pages] macros will only be evaluated on legacy documents at open time. The deprecated API still works but sends back a report error.

Cells containing these 2 macros will change type from FreeCell to ReportCell with the function page().

Custom applications that create document on the fly using getContainsMacro() and setContainsMacro() need to have their behavior changed to the following:

  1. Create a ReportCell in place of a FreeCell.
  2. Add the function page() or pages() to the ReportCell

Note: Attention, these formulae are localized

Original API Documentation below.

Determines if the contents of this cell should be checked for macros or not.

Parameters:
b - when true, the cell will be checked for macros
See Also:
FreeCell.getContainsMacro()

toReportCell

ReportCell toReportCell()
Turns a FreeCell into a ReportCell. The resulting cell retains its original attributes. contains a formula representation of the current text value. After calling this function, this cell is no longer part of the report and the new cell has taken its exact place.

Returns:
a report cell that replaces this cell
Since:
11.5
See Also:
ReportCell.toFreeCell()