Class HeaderBlock

  • All Implemented Interfaces:
    Cloneable, Block

    public class HeaderBlock
    extends AbstractBlock
    Since:
    1.5M2
    Version:
    $Id: 57eed3d4285d1c84b58bf6f1a3ff9899b1aa060b $
    • Constructor Detail

      • HeaderBlock

        public HeaderBlock​(List<Block> childBlocks,
                           HeaderLevel level)
        Parameters:
        childBlocks - the children of the header.
        level - the level of the header
      • HeaderBlock

        public HeaderBlock​(List<Block> childBlocks,
                           HeaderLevel level,
                           Map<String,​String> parameters)
        Parameters:
        childBlocks - the children of the header.
        level - the level of the header
        parameters - the parameters of the header
      • HeaderBlock

        public HeaderBlock​(List<Block> childBlocks,
                           HeaderLevel level,
                           String id)
        Parameters:
        childBlocks - the children of the header.
        level - the level of the header
        id - the id of the header.
      • HeaderBlock

        public HeaderBlock​(List<Block> childBlocks,
                           HeaderLevel level,
                           Map<String,​String> parameters,
                           String id)
        Parameters:
        childBlocks - the children of the header.
        level - the level of the header
        parameters - the parameters of the header
        id - the id of the header.
    • Method Detail

      • getLevel

        public HeaderLevel getLevel()
        Returns:
        the level of the header
      • getId

        public String getId()
        Returns:
        the id of the header.
      • setId

        @Unstable
        public void setId​(String id)
        Parameters:
        id - the id of the header to set
        Since:
        14.2RC1
      • before

        public void before​(Listener listener)
        Description copied from class: AbstractBlock
        Send Listener events corresponding to the start of the block. For example for a Bold block, this allows an XHTML Listener (aka a Renderer) to output <b>.
        Overrides:
        before in class AbstractBlock
        Parameters:
        listener - the listener that will receive the events sent by this block before its children blocks have emitted their own events.
      • after

        public void after​(Listener listener)
        Description copied from class: AbstractBlock
        Send Listener events corresponding to the end of the block. For example for a Bold block, this allows an XHTML Listener (aka a Renderer) to output </b>.
        Overrides:
        after in class AbstractBlock
        Parameters:
        listener - the listener that will receive the events sent by this block before its children blocks have emitted their own events.