12.12. The OpenCReport\Column class #

12.12.1. Get next column
12.12.2. Create a new report in the column
12.12.3. Get first report of a part column
12.12.4. Set or get part column suppression
12.12.5. Set or get part column width
12.12.6. Set or get part column height
12.12.7. Set or get border width
12.12.8. Set or get border color
12.12.9. Set or get number of detail columns
12.12.10. Set or get column padding

class OpenCReport\Column {
    public final get_next():
                     ?OpenCReport\Column;

    public final report_new():
                     OpenCReport\Report;

    public final report_get_first():
                     ?OpenCReport\Report;

    public final set_suppress(
                     ?string $expr_string = null):
                     ??OpenCReport\Expr;

    public final get_suppress():
                     ??OpenCReport\Expr;

    public final set_width(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_width():
                     ?OpenCReport\Expr;

    public final set_width(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_width():
                     ?OpenCReport\Expr;

    public final set_border_width(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_border_width():
                     ?OpenCReport\Expr;

    public final set_border_color(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_border_color():
                     ?OpenCReport\Expr;

    public final set_detail_columns(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_detail_columns():
                     ?OpenCReport\Expr;

    public final set_column_padding(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_column_padding():
                     ?OpenCReport\Expr;
}

12.12.1. Get next column #

Get the next object in the chain of part columns. This method may only be used on an object created with OpenCReport\Row::column_get_first(), i.e. one that was internally marked as an iterator object.

public final
OpenCReport\Column::get_next():
                     ?OpenCReport\Column;

12.12.2. Create a new report in the column #

For class methods of OpenCReport\Report, see Section 12.13.

public final
OpenCReport\Column::report_new():
                     OpenCReport\Report;

12.12.3. Get first report of a part column #

Get the first report from the part column. The object is marked internally as an iterator. For class methods of OpenCReport\Report, see Section 12.13

public final
OpenCReport\Column::report_get_first():
                     ?OpenCReport\Report;

12.12.4. Set or get part column suppression #

public final
OpenCReport\Column::set_suppress(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Column::get_suppress():
                     ?OpenCReport\Expr;

12.12.5. Set or get part column width #

Set the width of the whole part column. If an inner report is wider than the column width, it's rendering is truncated.

public final
OpenCReport\Column::set_width(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Column::get_width():
                     ?OpenCReport\Expr;

12.12.6. Set or get part column height #

Set the part column height. During report execution, the column height is calculated for rendering. Inner reports and the height of their lines that would be rendered are added. New lines of a report that would exceed the part column height are not rendered and the report is rendered partially. The data shown in rendered lines are identical in both cases, whether or not the pre-set height is set. When the set column height is reached, further inner reports are not rendered. Default is unset, i.e. every inner report is fully rendered.

public final
OpenCReport\Column::set_height(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Column::get_height():
                     ?OpenCReport\Expr;

12.12.7. Set or get border width #

Set the border width around the part column. The width is in points (1/72 inches). Default is 0, i.e. a border is not rendered around the part column.

public final
OpenCReport\Column::set_border_width(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Column::get_border_width():
                     ?OpenCReport\Expr;

12.12.8. Set or get border color #

Set the border color around the part column. Only used if the border width is set.

public final
OpenCReport\Column::set_border_color(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Column::get_border_color():
                     ?OpenCReport\Expr;

12.12.9. Set or get number of detail columns #

Set the number of detail columns in the part column. Inner reports inside the part column may be narrow and visually wasteful with empty areas on the page. In this case, when a page break would occur, a column break would occur instead. Only reaching the last column would result in a page break.

public final
OpenCReport\Column::set_detail_columns(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Column::get_detail_columns():
                     ?OpenCReport\Expr;

12.12.10. Set or get column padding #

Set the padding between detail columns. It is used if the number of detail columns is greater than 1.

public final
OpenCReport\Column::set_column_padding(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Column::get_column_padding():
                     ?OpenCReport\Expr;