Package org.xwiki.rendering.block

Enum Block.Axes

  • All Implemented Interfaces:
    Serializable, Comparable<Block.Axes>
    Enclosing interface:
    Block
    public static enum Block.Axes
extends Enum<Block.Axes>
    Search axes used in searching methods. Mostly taken from XPATH axes.
    Since:
    3.0M3
    Version:
    $Id: 47994a01e00ed849219e09943bc6639065eefc4e $

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ANCESTOR
      The ancestors of the context block; the ancestors of the context block consist of the parent of context block and the parent's parent and so on; thus, the ancestor axis will always include the root block, unless the context block is the root block.
      ANCESTOR_OR_SELF
      The context block and the ancestors of the context block; thus, the ancestor axis will always include the root block.
      CHILD
      The children of the context block.
      DESCENDANT
      The descendants of the context block; a descendant is a child or a child of a child and so on.
      DESCENDANT_OR_SELF
      The context block and the descendants of the context block.
      FOLLOWING
      All blocks in the same document as the context block that are after the context block in document order, excluding any descendants.
      FOLLOWING_SIBLING
      All the following siblings of the context block.
      PARENT
      The parent of the context block, if there is one.
      PRECEDING
      All blocks in the same document as the context block that are before the context block in document order, excluding any ancestors.
      PRECEDING_SIBLING
      All the preceding siblings of the context block.
      SELF
      Just the context block itself.

    • Enum Constant Detail

      • SELF

        public static final Block.Axes SELF
        Just the context block itself.

      • PARENT

        public static final Block.Axes PARENT
        The parent of the context block, if there is one.

      • ANCESTOR

        public static final Block.Axes ANCESTOR
        The ancestors of the context block; the ancestors of the context block consist of the parent of context block and the parent's parent and so on; thus, the ancestor axis will always include the root block, unless the context block is the root block.

      • ANCESTOR_OR_SELF

        public static final Block.Axes ANCESTOR_OR_SELF
        The context block and the ancestors of the context block; thus, the ancestor axis will always include the root block.

      • CHILD

        public static final Block.Axes CHILD
        The children of the context block.

      • DESCENDANT

        public static final Block.Axes DESCENDANT
        The descendants of the context block; a descendant is a child or a child of a child and so on.

      • DESCENDANT_OR_SELF

        public static final Block.Axes DESCENDANT_OR_SELF
        The context block and the descendants of the context block.

      • FOLLOWING

        public static final Block.Axes FOLLOWING
        All blocks in the same document as the context block that are after the context block in document order, excluding any descendants.

      • FOLLOWING_SIBLING

        public static final Block.Axes FOLLOWING_SIBLING
        All the following siblings of the context block.

      • PRECEDING

        public static final Block.Axes PRECEDING
        All blocks in the same document as the context block that are before the context block in document order, excluding any ancestors.

      • PRECEDING_SIBLING

        public static final Block.Axes PRECEDING_SIBLING
        All the preceding siblings of the context block.

    • Method Detail

      • values

        public static Block.Axes[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Block.Axes c : Block.Axes.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Block.Axes valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null