com.axemble.vdoc.sdk.interfaces.ui.definitions

Interface IBlockDefinition

All Superinterfaces:

IContentDefinition, Serializable

public interface IBlockDefinition
extends IContentDefinition

Base interface for block definition

Author:

omenuel

Method Summary

Modifier and Type	Method and Description
void	addFragment(IFragmentDefinition fragment) Add fragment to block
void	addNode(IContentDefinition node) Add node
void	addNodeAfter(IContentDefinition node, IContentDefinition addedNode) Add node addedNode after node
LinkedList<IContentDefinition>	findAllNodes() Find all children node Even nodes in subForm
<T extends IContentDefinition> List<T>	findAllNodes(Class<T> interfaceDefinition) Find all nodes recursively by interfaceDefinition Even nodes in subForm
IContentDefinition	findNode(String id, boolean recursive) Find node by id
<T extends IContentDefinition> IContentDefinition	findNodeByAttribute(Class<T> interfaceDefinition, String attributeName, String value, boolean recursive) Find node by interface definition class attribute name and value
<T extends IContentDefinition> List<T>	findNodes(Class<T> interfaceDefinition, boolean recursive) Find nodes by interfaceDefinition
<T extends IContentDefinition> List<T>	getAllNodes() Get all nodes recursively, except nodes in subFormInclude
String	getCssClass() Get cssClass
IFragmentDefinition	getFragmentByName(String name) Get fragment by name
List<IFragmentDefinition>	getFragments() Get fragments
List<IFragmentDefinition>	getFragmentsRecursively() Get all fragments recursively
List<? extends IContentDefinition>	getNodes() Get nodes
void	removeFragment(IFragmentDefinition fragment) Remove fragment to block
void	removeNode(IContentDefinition node) Remove node
void	setCssClass(String cssClass) Set cssClass
void	toXml(Node parentElement) Get the blockDefinition XML

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.definitions.IContentDefinition

clone, clone, getName, getParentBlock, getValue, getValues, setValue

Method Detail

getAllNodes

<T extends IContentDefinition> List<T> getAllNodes()

Get all nodes recursively, except nodes in subFormInclude

Returns:

nodes

findNodes

<T extends IContentDefinition> List<T> findNodes(Class<T> interfaceDefinition,
                                                 boolean recursive)

Find nodes by interfaceDefinition

Parameters:

interfaceDefinition -

recursive -

Returns:

nodes

findAllNodes

<T extends IContentDefinition> List<T> findAllNodes(Class<T> interfaceDefinition)

Find all nodes recursively by interfaceDefinition Even nodes in subForm

Parameters:

interfaceDefinition -

recursive -

Returns:

nodes

getNodes

List<? extends IContentDefinition> getNodes()

Get nodes

Returns:

nodes

addNode

void addNode(IContentDefinition node)

Add node

Parameters:

node -

addNodeAfter

void addNodeAfter(IContentDefinition node,
                  IContentDefinition addedNode)

Add node addedNode after node

Parameters:

node -

addedNode -

removeNode

void removeNode(IContentDefinition node)

Remove node

Parameters:

node -

getFragments

List<IFragmentDefinition> getFragments()

Get fragments

Returns:

fragments

getFragmentsRecursively

List<IFragmentDefinition> getFragmentsRecursively()

Get all fragments recursively

Returns:

fragments

getFragmentByName

IFragmentDefinition getFragmentByName(String name)

Get fragment by name

Parameters:

name -

Returns:

fragment

addFragment

void addFragment(IFragmentDefinition fragment)

Add fragment to block

Parameters:

fragment -

removeFragment

void removeFragment(IFragmentDefinition fragment)

Remove fragment to block

Parameters:

fragment -

getCssClass

String getCssClass()

Get cssClass

Returns:

cssClass

setCssClass

void setCssClass(String cssClass)

Set cssClass

Parameters:

cssClass -

toXml

void toXml(Node parentElement)

Get the blockDefinition XML

Parameters:

parentElement -

findNode

IContentDefinition findNode(String id,
                            boolean recursive)

Find node by id

Parameters:

id -

recursive -

Returns:

node

findNodeByAttribute

<T extends IContentDefinition> IContentDefinition findNodeByAttribute(Class<T> interfaceDefinition,
                                                                      String attributeName,
                                                                      String value,
                                                                      boolean recursive)

Find node by interface definition class attribute name and value

Parameters:

interfaceDefinition -

attributeName -

value -

recursive -

Returns:

node

findAllNodes

LinkedList<IContentDefinition> findAllNodes()

Find all children node Even nodes in subForm

Returns:

nodes