interface XChainable in module com::sun::star::util::

(Global Index)

Syntax

interface XChainable : com::sun::star::uno::XInterface ;

Description

enables the object to be a member of a chain.

Method Summary

getPredecessor

getSuccessor

setSuccessor connects the specified object to this object as the successor in a chain.

isChainable checks if the specified object can be linked to this.

Known Services Which Export this Interface

com::sun::star::text::ChainedTextFrame

Method Details



getPredecessor

Syntax

com::sun::star::util::XChainable getPredecessor ();

Returns

the previous object in this chain or NULL, if this is the first object of this chain.

getSuccessor

Syntax

com::sun::star::util::XChainable getSuccessor ();

Returns

the next object in this chain or NULL, if this is the last object in this chain.

setSuccessor

Syntax

void setSuccessor (
com::sun::star::util::XChainable xChainable )
raises ( com::sun::star::lang::IllegalArgumentException );

Description

connects the specified object to this object as the successor in a chain.

This implies that this object will become the predecessor of xChainable .


isChainable

Syntax

boolean isChainable (
com::sun::star::util::XChainable xChainable );

Description

checks if the specified object can be linked to this.

Top of Page