Package com.axemble.vdoc.sdk.impl

Class EzsBlock

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.PortalElement

com.axemble.vdoc.sdk.impl.EzsContentComponent

com.axemble.vdoc.sdk.impl.EzsBlock

All Implemented Interfaces:

IBlock, IContentComponent, IElement, Serializable

public class EzsBlock
extends EzsContentComponent
implements IBlock

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.axemble.vdoc.sdk.impl.EzsContentComponent

contentNodeImpl

Fields inherited from class com.axemble.vdoc.sdk.impl.PortalElement

path, storageKey

Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

module

Constructor Summary

Constructors

Constructor	Description
EzsBlock(IModule module, com.axemble.easysite.dao.domain.impl.BlockImpl blockImpl)

Method Summary

Modifier and Type	Method	Description
void	addBlock(IBlock block)	Adds a block.
void	addBlock(IBlock block, String path)	Adds a block.
void	addComponent(IComponent component)	Adds a component.
void	addComponent(IComponent component, String path)	Adds a component.
void	addFirstComponent(IComponent component)	Adds a component in the first position in the block.
IBlock	findBlockBySystemName(String name)	Searches a IBlock object by its system name.
IBlock	findBlockBySystemName(String name, boolean recursive)	Searches a IBlock object by its system name, recursively.
IComponent	findComponentBySystemName(String name)	Searches a IComponent object by its system name.
IComponent	findComponentBySystemName(String name, boolean recursive)	Searches a IComponent object by its system name, recursively.
IContentComponent	findContentComponentById(IStorageKey storageKey)	Searches a IContentComponent object by its identifier.
IContentComponent	findContentComponentById(IStorageKey storageKey, boolean recursive)	Searches a IContentComponent object by its identifier, recursively.
IContentComponent	findContentComponentBySystemName(String name)	Searches a IContentComponent object by its system name.
IContentComponent	findContentComponentBySystemName(String name, boolean recursive)	Searches a IContentComponent object by its system name, recursively.
IBlockTemplateContainer	getBlockTemplateContainer()	Gets the inherited block.
Collection<IContentComponent>	getContentComponents()	Gets all the content components (IBlock or IComponent elements).
protected final com.axemble.easysite.dao.domain.impl.BlockImpl	getInternalObject()
boolean	isRebuilt()	Checks if the block has been rebuilt.
void	removeBlock(IBlock block)	Removes a block.
void	removeComponent(IComponent component)	Removes a component.
void	replaceBlock(IBlock block, String path)	Replaces a block.
void	replaceComponent(IComponent component, String path)	Replaces a component.
void	setBlockTemplateContainer(IBlockTemplateContainer blockTemplateContainer)	Sets the block template container.

Methods inherited from class com.axemble.vdoc.sdk.impl.EzsContentComponent

getInnerCssClass, getInnerDescription, getInnerLabel, getInnerName, getNativeObject, getParentBlock, getSysName, getValue, getValue, isInnerNullable, isInnerReplaceable, setHidden, setInnerCssClass, setInnerDescription, setInnerLabel, setInnerName, setInnerNullable, setInnerReplaceable, setSysName, setValue

Methods inherited from class com.axemble.vdoc.sdk.impl.PortalElement

equals, getId, getPath, getProtocolURI, getProtocolURI, hashCode, replaceBackSlash, replaceSlash, save, setId

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

getModule

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IContentComponent

getInnerCssClass, getInnerDescription, getInnerLabel, getInnerName, getParentBlock, getSysName, getValue, getValue, isInnerNullable, isInnerReplaceable, setHidden, setInnerCssClass, setInnerNullable, setInnerReplaceable, setSysName, setValue

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Constructor Details

EzsBlock

public EzsBlock(IModule module,
 com.axemble.easysite.dao.domain.impl.BlockImpl blockImpl)

Method Details

getInternalObject

protected final com.axemble.easysite.dao.domain.impl.BlockImpl getInternalObject()

addBlock

public void addBlock(IBlock block)

Description copied from interface: IBlock

Adds a block.

Specified by:

addBlock in interface IBlock

Parameters:

block - The IBlock object to add.

addBlock

public void addBlock(IBlock block,
 String path)

Description copied from interface: IBlock

Adds a block.

Specified by:

addBlock in interface IBlock

Parameters:

block - The IBlock object to add.

path - The path of the component to replace.

replaceBlock

public void replaceBlock(IBlock block,
 String path)

Description copied from interface: IBlock

Replaces a block.

Specified by:

replaceBlock in interface IBlock

Parameters:

block - The IBlock object to replace.

path - The path of the component to replace.

addComponent

public void addComponent(IComponent component)

Description copied from interface: IBlock

Adds a component.

Specified by:

addComponent in interface IBlock

Parameters:

component - The IComponent object to add.

addFirstComponent

public void addFirstComponent(IComponent component)

Description copied from interface: IBlock

Adds a component in the first position in the block.

Specified by:

addFirstComponent in interface IBlock

Parameters:

component - The IComponent object to add.

addComponent

public void addComponent(IComponent component,
 String path)

Description copied from interface: IBlock

Adds a component.

Specified by:

addComponent in interface IBlock

Parameters:

component - The IComponent object to add.

path - The path of the component to replace.

replaceComponent

public void replaceComponent(IComponent component,
 String path)

Description copied from interface: IBlock

Replaces a component.

Specified by:

replaceComponent in interface IBlock

Parameters:

component - The IComponent object to replace.

path - The path of the component to replace.

getContentComponents

public Collection<IContentComponent> getContentComponents()

Description copied from interface: IBlock

Gets all the content components (IBlock or IComponent elements).

Specified by:

getContentComponents in interface IBlock

Returns:

A java.util.Collection of IContentComponent objects.

removeBlock

public void removeBlock(IBlock block)

Description copied from interface: IBlock

Removes a block.

Specified by:

removeBlock in interface IBlock

Parameters:

block - The IBlock object to remove.

removeComponent

public void removeComponent(IComponent component)

Description copied from interface: IBlock

Removes a component.

Specified by:

removeComponent in interface IBlock

Parameters:

component - The IComponent object to remove.

getBlockTemplateContainer

public IBlockTemplateContainer getBlockTemplateContainer()

Description copied from interface: IBlock

Gets the inherited block.

Specified by:

getBlockTemplateContainer in interface IBlock

Returns:

A IBlockTemplateContainer object.

setBlockTemplateContainer

public void setBlockTemplateContainer(IBlockTemplateContainer blockTemplateContainer)

Description copied from interface: IBlock

Sets the block template container.

Specified by:

setBlockTemplateContainer in interface IBlock

Parameters:

blockTemplateContainer - The IBlockTemplateContainer to set.

findContentComponentById

public IContentComponent findContentComponentById(IStorageKey storageKey)

Description copied from interface: IBlock

Searches a IContentComponent object by its identifier.

Specified by:

findContentComponentById in interface IBlock

Parameters:

storageKey - The IStorageKey object to search with.

Returns:

A IContentComponent object.

findContentComponentById

public IContentComponent findContentComponentById(IStorageKey storageKey,
 boolean recursive)

Description copied from interface: IBlock

Searches a IContentComponent object by its identifier, recursively.

Specified by:

findContentComponentById in interface IBlock

Parameters:

storageKey - The IStorageKey object to search with.

recursive - Specify if recursive.

Returns:

A IContentComponent object.

findBlockBySystemName

public IBlock findBlockBySystemName(String name)

Description copied from interface: IBlock

Searches a IBlock object by its system name.

Specified by:

findBlockBySystemName in interface IBlock

Parameters:

name - The system name of the child block.

Returns:

A IBlock object.

findBlockBySystemName

public IBlock findBlockBySystemName(String name,
 boolean recursive)

Description copied from interface: IBlock

Searches a IBlock object by its system name, recursively.

Specified by:

findBlockBySystemName in interface IBlock

Parameters:

name - The system name of the child block.

recursive - Specify if recursive.

Returns:

A IBlock object.

findComponentBySystemName

public IComponent findComponentBySystemName(String name)

Description copied from interface: IBlock

Searches a IComponent object by its system name.

Specified by:

findComponentBySystemName in interface IBlock

Parameters:

name - The system name of the child component.

Returns:

A IComponent object.

findComponentBySystemName

public IComponent findComponentBySystemName(String name,
 boolean recursive)

Description copied from interface: IBlock

Searches a IComponent object by its system name, recursively.

Specified by:

findComponentBySystemName in interface IBlock

Parameters:

name - The system name of the child component.

recursive - Specify if recursive.

Returns:

A IComponent object.

findContentComponentBySystemName

public IContentComponent findContentComponentBySystemName(String name)

Description copied from interface: IBlock

Searches a IContentComponent object by its system name.

Specified by:

findContentComponentBySystemName in interface IBlock

Parameters:

name - The system name of the child content component.

Returns:

A IContentComponent object.

findContentComponentBySystemName

public IContentComponent findContentComponentBySystemName(String name,
 boolean recursive)

Description copied from interface: IBlock

Searches a IContentComponent object by its system name, recursively.

Specified by:

findContentComponentBySystemName in interface IBlock

Parameters:

name - The system name of the child content component.

recursive - Specify if recursive.

Returns:

A IContentComponent object.

isRebuilt

public boolean isRebuilt()

Description copied from interface: IBlock

Checks if the block has been rebuilt.

Specified by:

isRebuilt in interface IBlock

Returns:

true if the block has been rebuilt, false otherwise.