org.asciidoctor.ast.Column Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of asciidoctorj-api Show documentation

API for AsciidoctorJ

There is a newer version: 3.0.0

package org.asciidoctor.ast;

public interface Column extends ContentNode {

    /**
     * Returns the style of this column.
     * The default is {@code null}.
     * Possible values are:
     * 
     *     {@code null}
     *     {@code "strong"}
     *     {@code "emphasis"}
     *     {@code "monospaced"}
     *     {@code "header"}
     *     {@code "literal"}
     *     {@code "verse"}
     *     {@code "asciidoc"}
     * 
     * @return The style of this cell.
     */
    String getStyle();

    /**
     * Sets the style of this column.
     * @see #getStyle()
     * @param style Values like {@code asciidoc}, {@code verse}, {@code literal}or {@code header}.
     */
    void setStyle(String style);

    Table getTable();

    int getColumnNumber();

    int getWidth();

    void setWidth(int width);

    /**
     * Returns the horizonzal alignment of all cells in this column.
     * @return a constant representing the horizontal alignment.
     */
    Table.HorizontalAlignment getHorizontalAlignment();

    /**
     * Sets the horizontal alignment of all cells of this column.
     * @param halign Either {@link Table.HorizontalAlignment#LEFT}, {@link Table.HorizontalAlignment#CENTER} or {@link Table.HorizontalAlignment#RIGHT}
     */
    void setHorizontalAlignment(Table.HorizontalAlignment halign);

    /**
     * Returns the vertical alignment of all cells in this column.
     * @return a constant representing the vertical alignment.
     */
    Table.VerticalAlignment getVerticalAlignment();

    /**
     * Sets the vertical alignment of all cells of this column.
     * @param valign Either {@link Table.VerticalAlignment#TOP}, {@link Table.VerticalAlignment#MIDDLE} or {@link Table.VerticalAlignment#BOTTOM}
     */
    void setVerticalAlignment(Table.VerticalAlignment valign);

}