Package com.axemble.vdoc.sdk.interfaces

Interface IBlock

All Superinterfaces:
IContentComponent, IElement, Serializable
All Known Implementing Classes:
EzsBlock
public interface IBlock extends IContentComponent
This interface represents a block element.
Since:
2.1
Version:
1.0, 16/06/2009
Author:
vlygeros

  • Method Details

    • addBlock

      void addBlock(IBlock block)
      Adds a block.
      Parameters:
      block - The IBlock object to add.

    • addBlock

      void addBlock(IBlock block, String path)
      Adds a block.
      Parameters:
      block - The IBlock object to add.
      path - The path of the component to replace.

    • addComponent

      void addComponent(IComponent component)
      Adds a component.
      Parameters:
      component - The IComponent object to add.

    • addFirstComponent

      void addFirstComponent(IComponent component)
      Adds a component in the first position in the block.
      Parameters:
      component - The IComponent object to add.

    • addComponent

      void addComponent(IComponent component, String path)
      Adds a component.
      Parameters:
      component - The IComponent object to add.
      path - The path of the component to replace.

    • replaceBlock

      void replaceBlock(IBlock block, String path)
      Replaces a block.
      Parameters:
      block - The IBlock object to replace.
      path - The path of the component to replace.

    • replaceComponent

      void replaceComponent(IComponent component, String path)
      Replaces a component.
      Parameters:
      component - The IComponent object to replace.
      path - The path of the component to replace.

    • getContentComponents

      Collection<IContentComponent> getContentComponents()
      Gets all the content components (IBlock or IComponent elements).
      Returns:
      A java.util.Collection of IContentComponent objects.

    • removeBlock

      void removeBlock(IBlock block)
      Removes a block.
      Parameters:
      block - The IBlock object to remove.

    • removeComponent

      void removeComponent(IComponent component)
      Removes a component.
      Parameters:
      component - The IComponent object to remove.

    • getBlockTemplateContainer

      IBlockTemplateContainer getBlockTemplateContainer()
      Gets the inherited block.
      Returns:
      A IBlockTemplateContainer object.

    • setBlockTemplateContainer

      void setBlockTemplateContainer(IBlockTemplateContainer blockTemplateContainer)
      Sets the block template container.
      Parameters:
      blockTemplateContainer - The IBlockTemplateContainer to set.

    • findContentComponentById

      IContentComponent findContentComponentById(IStorageKey storageKey)
      Searches a IContentComponent object by its identifier.
      Parameters:
      storageKey - The IStorageKey object to search with.
      Returns:
      A IContentComponent object.

    • findContentComponentById

      IContentComponent findContentComponentById(IStorageKey storageKey, boolean recursive)
      Searches a IContentComponent object by its identifier, recursively.
      Parameters:
      storageKey - The IStorageKey object to search with.
      recursive - Specify if recursive.
      Returns:
      A IContentComponent object.

    • findContentComponentBySystemName

      IContentComponent findContentComponentBySystemName(String name)
      Searches a IContentComponent object by its system name.
      Parameters:
      name - The system name of the child content component.
      Returns:
      A IContentComponent object.

    • findContentComponentBySystemName

      IContentComponent findContentComponentBySystemName(String name, boolean recursive)
      Searches a IContentComponent object by its system name, recursively.
      Parameters:
      name - The system name of the child content component.
      recursive - Specify if recursive.
      Returns:
      A IContentComponent object.

    • findComponentBySystemName

      IComponent findComponentBySystemName(String name)
      Searches a IComponent object by its system name.
      Parameters:
      name - The system name of the child component.
      Returns:
      A IComponent object.

    • findComponentBySystemName

      IComponent findComponentBySystemName(String name, boolean recursive)
      Searches a IComponent object by its system name, recursively.
      Parameters:
      name - The system name of the child component.
      recursive - Specify if recursive.
      Returns:
      A IComponent object.

    • findBlockBySystemName

      IBlock findBlockBySystemName(String name)
      Searches a IBlock object by its system name.
      Parameters:
      name - The system name of the child block.
      Returns:
      A IBlock object.

    • findBlockBySystemName

      IBlock findBlockBySystemName(String name, boolean recursive)
      Searches a IBlock object by its system name, recursively.
      Parameters:
      name - The system name of the child block.
      recursive - Specify if recursive.
      Returns:
      A IBlock object.

    • isRebuilt

      boolean isRebuilt()
      Checks if the block has been rebuilt.
      Returns:
      true if the block has been rebuilt, false otherwise.