com.axemble.vdoc.sdk.interfaces.ui.designer

Interface IDesignBlock

All Superinterfaces:

ICompilationSupport, IDesignContentComponent, IDesignElement, ILocationSupport, IPropertiesSupport, ISelectionSupport, IWidget, IWritable, IXmlSerializable, Serializable

All Known Subinterfaces:

IDesignCellBlock, IDesignFormBlock, IDesignLineBlock, IDesignSectionBlock, IDesignTableBlock

public interface IDesignBlock
extends IDesignContentComponent, ICompilationSupport

Interface to describe block object.

Since:

2.0, 01/12/2010

Version:

1.0

Author:

vlygeros

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IDesignBlock.SupportedEventTypes Specific event types.

Method Summary

Modifier and Type	Method and Description
IDesignBlock	createDesignBlock(IBlockDefinition blockDefinition) Creates a design block by specifying its definition.
IDesignBlock	createDesignBlock(String name) Creates a design block by specifying its name.
IDesignBlock	createDesignBlockAfter(IBlockDefinition blockDefinition, IDesignContentComponent previousSibling) Creates a design block by specifying its definition.
IDesignBlock	createDesignBlockAfter(String name, IDesignContentComponent previousSibling) Creates a design block by specifying its name.
IDesignBlock	createDesignBlockBefore(IBlockDefinition blockDefinition, IDesignContentComponent nextSibling) Creates a design block by specifying its definition.
IDesignBlock	createDesignBlockBefore(String name, IDesignContentComponent nextSibling) Creates a design block by specifying its name.
IDesignComponent	createDesignComponent(IComponentDefinition componentDefinition) Creates a design component by specifying its definition.
IDesignComponent	createDesignComponent(String name) Creates a design component by specifying its name.
IDesignComponent	createDesignComponentAfter(IComponentDefinition componentDefinition, IDesignContentComponent previousSibling) Creates a design component by specifying its definition.
IDesignComponent	createDesignComponentAfter(String name, IDesignContentComponent previousSibling) Creates a design component by specifying its name.
IDesignComponent	createDesignComponentBefore(IComponentDefinition componentDefinition, IDesignContentComponent nextSibling) Creates a design component by specifying its definition.
IDesignComponent	createDesignComponentBefore(String name, IDesignContentComponent nextSibling) Creates a design component by specifying its name.
IBlockDefinition	getBlockDefinition() Gets the internal block definition.

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.designer.ILocationSupport

getDimension, getPoint, setDimension, setPoint

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.designer.ISelectionSupport

deselect, isSelected, select

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.designer.IDesignElement

allowRemove, delete, getContainer, getId, getLinkedDesignElementsGroupName, getUniqueGroupName, getUniqueName, isDirty, isEmbedded, isPersistent, isVolatile, setAllowRemove, setDirty, verify

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.IWidget

afterInit, getParentBlock, getSysname, isHidden, refresh, render, setHidden, setParentBlock, setSysname

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.IWritable

write

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.designer.IXmlSerializable

load, save

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.designer.IPropertiesSupport

getDescription, getLabel, getName, setDescription, setLabel, setName

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.ui.designer.ICompilationSupport

beforeCompile, beforeMerge, compile, generateName, merge

Method Detail

createDesignBlock

IDesignBlock createDesignBlock(String name)

Creates a design block by specifying its name.

Parameters:

name - The name of the block to create.

Returns:

A IDesignBlock object.

createDesignBlockBefore

IDesignBlock createDesignBlockBefore(String name,
                                     IDesignContentComponent nextSibling)

Creates a design block by specifying its name.

Parameters:

name - The name of the block to create.

nextSibling - The next sibling component.

Returns:

A IDesignBlock object.

createDesignBlockAfter

IDesignBlock createDesignBlockAfter(String name,
                                    IDesignContentComponent previousSibling)

Creates a design block by specifying its name.

Parameters:

name - The name of the block to create.

previousSibling - The previous sibling component.

Returns:

A IDesignBlock object.

createDesignBlock

IDesignBlock createDesignBlock(IBlockDefinition blockDefinition)

Creates a design block by specifying its definition.

Parameters:

blockDefinition - The specific block definition to use.

Returns:

A IDesignBlock object.

createDesignBlockBefore

IDesignBlock createDesignBlockBefore(IBlockDefinition blockDefinition,
                                     IDesignContentComponent nextSibling)

Creates a design block by specifying its definition.

Parameters:

blockDefinition - The specific block definition to use.

nextSibling - The next sibling component.

Returns:

A IDesignBlock object.

createDesignBlockAfter

IDesignBlock createDesignBlockAfter(IBlockDefinition blockDefinition,
                                    IDesignContentComponent previousSibling)

Creates a design block by specifying its definition.

Parameters:

blockDefinition - The specific block definition to use.

previousSibling - The previous sibling component.

Returns:

A IDesignBlock object.

createDesignComponent

IDesignComponent createDesignComponent(String name)

Creates a design component by specifying its name.

Parameters:

name - The name of the component to create.

Returns:

A IDesignComponent object.

createDesignComponentBefore

IDesignComponent createDesignComponentBefore(String name,
                                             IDesignContentComponent nextSibling)

Creates a design component by specifying its name.

Parameters:

name - The name of the component to create.

nextSibling - The next sibling component.

Returns:

A IDesignComponent object.

createDesignComponentAfter

IDesignComponent createDesignComponentAfter(String name,
                                            IDesignContentComponent previousSibling)

Creates a design component by specifying its name.

Parameters:

name - The name of the component to create.

previousSibling - The previous sibling component.

Returns:

A IDesignComponent object.

createDesignComponent

IDesignComponent createDesignComponent(IComponentDefinition componentDefinition)

Creates a design component by specifying its definition.

Parameters:

componentDefinition - The specific component definition to use.

Returns:

A IDesignComponent object.

createDesignComponentBefore

IDesignComponent createDesignComponentBefore(IComponentDefinition componentDefinition,
                                             IDesignContentComponent nextSibling)

Creates a design component by specifying its definition.

Parameters:

componentDefinition - The specific component definition to use.

nextSibling - The next sibling component.

Returns:

A IDesignComponent object.

createDesignComponentAfter

IDesignComponent createDesignComponentAfter(IComponentDefinition componentDefinition,
                                            IDesignContentComponent previousSibling)

Creates a design component by specifying its definition.

Parameters:

componentDefinition - The specific component definition to use.

previousSibling - The previous sibling component.

Returns:

A IDesignComponent object.

getBlockDefinition

IBlockDefinition getBlockDefinition()

Gets the internal block definition.

Returns:

A IBlockDefinition object.