com.axemble.vdoc.sdk.interfaces

Interface IContentComponent

All Superinterfaces:

IElement, Serializable

All Known Subinterfaces:

IBlock, IComponent

public interface IContentComponent
extends IElement

This interface represents a block element.

Since:

2.1

Version:

1.0, 16/06/2009

Author:

vlygeros

Method Summary

Modifier and Type	Method and Description
String	getInnerCssClass() Gets the CSS class.
String	getInnerDescription() Gets the description of the IContentComponent object.
String	getInnerLabel() Gets the label of the IContentComponent object.
String	getInnerName() Gets the name of the IContentComponent object.
IBlock	getParentBlock() Gets the parent block.
Object	getValue(String propertyName) Gets the value of a property.
Object	getValue(String propertyName, Object defaultValue) Gets the value of a property.
boolean	isInnerNullable() Checks if the block is nullable.
boolean	isInnerReplaceable() Checks if the block is replaceable.
void	setHidden(String propertyName) Hides a property.
void	setInnerCssClass(String cssClass) Sets the CSS class
void	setInnerNullable(boolean nullable) Allows to specify the block is nullable.
void	setInnerReplaceable(boolean replaceable) Allows to specify the block is replaceable.
void	setValue(String propertyName, Object value) Sets a value to a property

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

getId, getModule, getNativeObject, getPath, save

Method Detail

getInnerName

String getInnerName()

Gets the name of the IContentComponent object.

Returns:

The system name of the content component.

getInnerLabel

String getInnerLabel()

Gets the label of the IContentComponent object.

Returns:

The label of the content component.

getInnerDescription

String getInnerDescription()

Gets the description of the IContentComponent object.

Returns:

The description of the content component.

getInnerCssClass

String getInnerCssClass()

Gets the CSS class.

Returns:

A java.lang.String representing the class name used by the block.

setInnerCssClass

void setInnerCssClass(String cssClass)

Sets the CSS class

Parameters:

cssClass -

isInnerReplaceable

boolean isInnerReplaceable()

Checks if the block is replaceable.

Returns:

true if the block is replaceable, false otherwise.

setInnerReplaceable

void setInnerReplaceable(boolean replaceable)

Allows to specify the block is replaceable.

Parameters:

replaceable - The flag to set.

isInnerNullable

boolean isInnerNullable()

Checks if the block is nullable.

Returns:

true if the block is nullable, false otherwise.

setInnerNullable

void setInnerNullable(boolean nullable)

Allows to specify the block is nullable.

Parameters:

nullable - The flag to set.

getValue

Object getValue(String propertyName)

Gets the value of a property.

Parameters:

propertyName - The system name of the property.

Returns:

A Object object.

getValue

Object getValue(String propertyName,
                Object defaultValue)

Gets the value of a property. Allows to specify a default value, if the internale value is null.

Parameters:

propertyName - The system name of the property.

defaultValue -

Returns:

A Object object.

setValue

void setValue(String propertyName,
              Object value)

Sets a value to a property

Parameters:

propertyName - The system name of the property.

value - The value object to set.

setHidden

void setHidden(String propertyName)

Hides a property.

Parameters:

propertyName - The system name of the property.

getParentBlock

IBlock getParentBlock()

Gets the parent block.

Returns:

A IBlock object.