ag.ion.bion.officelayer.clone
Interface ICloneService

All Known Implementing Classes:

AbstractCloneService, ETextTableCellRangeCloneService, ETextTableCloneService, ParagraphCloneService, TextTableCellCloneService, TextTableCellRangeCloneService, TextTableCloneService, TextTableColumnCloneService, TextTableRowCloneService

public interface ICloneService

The ICloneService interface, should be implemented by all coleable structures like tables and else.

Method Summary

IClonedObject	cloneAfterThisPosition(IDestinationPosition position, boolean adoptContent, PropertyKeysContainer propertyKeysContainer) Clones the chosen object after the given position and then returns a reference.
IClonedObject	cloneAfterThisPosition(IDestinationPosition position, PropertyKeysContainer propertyKeysContainer) Clones the chosen object to the given position and then returns a reference Between the given position and the newly created object there will be a paragraph to add some space betwwen them.
void	cloneAfterThisPositionNoReturn(IDestinationPosition position, boolean adoptContent, PropertyKeysContainer propertyKeysContainer) Clones the chosen object after the given position.
void	cloneAfterThisPositionNoReturn(IDestinationPosition position, PropertyKeysContainer propertyKeysContainer) Clones the chosen object to the given position.
void	cloneAfterThisPositions(IDestinationPosition[] positions, boolean adoptContent, PropertyKeysContainer propertyKeysContainer) Clones the chosen object after the given positions.
void	cloneAfterThisPositions(IDestinationPosition[] positions, PropertyKeysContainer propertyKeysContainer) Clones the chosen object to the given positions.
IClonedObject	cloneToPosition(IDestinationPosition position, boolean adoptContent, PropertyKeysContainer propertyKeysContainer) Clones the chosen object to the given position and then returns a reference This method also enables to adopts the content of the object (the default is to adopt, otherwise the paramter has to be set to false)
IClonedObject	cloneToPosition(IDestinationPosition position, PropertyKeysContainer propertyKeysContainer) Clones the chosen object to the given position and then returns a reference
void	cloneToPositionNoReturn(IDestinationPosition position, boolean adoptContent, PropertyKeysContainer propertyKeysContainer) Clones the chosen object to the given position.
void	cloneToPositionNoReturn(IDestinationPosition position, PropertyKeysContainer propertyKeysContainer) Clones the chosen object to the given position.
void	cloneToPositions(IDestinationPosition[] positions, boolean adoptContent, PropertyKeysContainer propertyKeysContainer) Clones the chosen object to the given positions.
void	cloneToPositions(IDestinationPosition[] positions, PropertyKeysContainer propertyKeysContainer) Clones the chosen object to the given positions.

Method Detail

cloneToPosition

IClonedObject cloneToPosition(IDestinationPosition position,
                              PropertyKeysContainer propertyKeysContainer)
                              throws CloneException

Clones the chosen object to the given position and then returns a reference

Parameters:

position - the positions the object is to be cloned to

propertyKeysContainer - container for property keys used for cloning style, my be null

Returns:

a reference to the newly cloned element

Throws:

CloneException - if the object could not be cloned.

cloneToPositionNoReturn

void cloneToPositionNoReturn(IDestinationPosition position,
                             PropertyKeysContainer propertyKeysContainer)
                             throws CloneException

Clones the chosen object to the given position.

Parameters:

position - the positions the object is to be cloned to

propertyKeysContainer - container for property keys used for cloning style, my be null

Throws:

CloneException - if the object could not be cloned.

cloneToPositions

void cloneToPositions(IDestinationPosition[] positions,
                      PropertyKeysContainer propertyKeysContainer)
                      throws CloneException

Clones the chosen object to the given positions. Does not return a reference.

Parameters:

positions - the positions the object is to be cloned to

propertyKeysContainer - container for property keys used for cloning style, my be null

Throws:

CloneException - if the object could not be cloned.

cloneToPosition

IClonedObject cloneToPosition(IDestinationPosition position,
                              boolean adoptContent,
                              PropertyKeysContainer propertyKeysContainer)
                              throws CloneException

Clones the chosen object to the given position and then returns a reference This method also enables to adopts the content of the object (the default is to adopt, otherwise the paramter has to be set to false)

Parameters:

position - the positions the object is to be cloned to

adoptContent - indicated if the content of the object should be adopted

propertyKeysContainer - container for property keys used for cloning style, my be null

Returns:

a reference to the newly cloned element

Throws:

CloneException - if the object could not be cloned.

cloneToPositionNoReturn

void cloneToPositionNoReturn(IDestinationPosition position,
                             boolean adoptContent,
                             PropertyKeysContainer propertyKeysContainer)
                             throws CloneException

Clones the chosen object to the given position. This method also enables to adopts the content of the object (the default is to adopt, otherwise the paramter has to be set to false)

Parameters:

position - the positions the object is to be cloned to

adoptContent - indicated if the content of the object should be adopted

propertyKeysContainer - container for property keys used for cloning style, my be null

Throws:

CloneException - if the object could not be cloned.

cloneToPositions

void cloneToPositions(IDestinationPosition[] positions,
                      boolean adoptContent,
                      PropertyKeysContainer propertyKeysContainer)
                      throws CloneException

Clones the chosen object to the given positions. Does not return a reference. This method also enables to adopts the content of the object (the default is to adopt, otherwise the paramter has to be set to false) .

Parameters:

positions - the positions the object is to be cloned to

adoptContent - indicated if the content of the object should be adopted

propertyKeysContainer - container for property keys used for cloning style, my be null

Throws:

CloneException - if the object could not be cloned.

cloneAfterThisPosition

IClonedObject cloneAfterThisPosition(IDestinationPosition position,
                                     PropertyKeysContainer propertyKeysContainer)
                                     throws CloneException

Clones the chosen object to the given position and then returns a reference Between the given position and the newly created object there will be a paragraph to add some space betwwen them. So the object WILL NOT be merged together. This method is optional because it does not make sense to all possible implementors of the interface. So it can happen that this method does nothing more or less than the cloneToPosition method. This method always adopts the content

Parameters:

position - the position the object is to be cloned after

propertyKeysContainer - container for property keys used for cloning style, my be null

Returns:

a reference to the newly cloned element

Throws:

CloneException - if the object could not be cloned.

cloneAfterThisPositionNoReturn

void cloneAfterThisPositionNoReturn(IDestinationPosition position,
                                    PropertyKeysContainer propertyKeysContainer)
                                    throws CloneException

Clones the chosen object to the given position. Between the given position and the newly created object there will be a paragraph to add some space betwwen them. So the object WILL NOT be merged together. This method is optional because it does not make sense to all possible implementors of the interface. So it can happen that this method does nothing more or less than the cloneToPosition method. This method always adopts the content

Parameters:

position - the position the object is to be cloned after

propertyKeysContainer - container for property keys used for cloning style, my be null

Throws:

CloneException - if the object could not be cloned.

cloneAfterThisPositions

void cloneAfterThisPositions(IDestinationPosition[] positions,
                             PropertyKeysContainer propertyKeysContainer)
                             throws CloneException

Clones the chosen object to the given positions. Does not return a reference. Between the given positions and the newly created object there will be a paragraph to add some space betwwen them. So the object WILL NOT be merged together. This method is optional because it does not make sense to all possible implementors of the interface. So it can happen that this method does nothing more or less than the cloneToPosition method. This method always adopts the content

Parameters:

positions - the positions the object is to be cloned after

propertyKeysContainer - container for property keys used for cloning style, my be null

Throws:

CloneException - if the object could not be cloned.

cloneAfterThisPosition

IClonedObject cloneAfterThisPosition(IDestinationPosition position,
                                     boolean adoptContent,
                                     PropertyKeysContainer propertyKeysContainer)
                                     throws CloneException

Clones the chosen object after the given position and then returns a reference. Between the given position and the newly created object there will be a paragraph to add some space betwwen them. So the object WILL NOT be merged together. This method is optional because it does not make sense to all possible implementors of the interface. So it can happen that this method does nothing more or less than the cloneToPosition method. This method also enables to adopts the content of the object (the default is to adopt, otherwise the paramter has to be set to false)

Parameters:

position - the position the object is to be cloned after

adoptContent - indicated if the content of the object should be adopted

propertyKeysContainer - container for property keys used for cloning style, my be null

Returns:

a reference to the newly cloned element

Throws:

CloneException - if the object could not be cloned.

cloneAfterThisPositionNoReturn

void cloneAfterThisPositionNoReturn(IDestinationPosition position,
                                    boolean adoptContent,
                                    PropertyKeysContainer propertyKeysContainer)
                                    throws CloneException

Clones the chosen object after the given position. Between the given position and the newly created object there will be a paragraph to add some space betwwen them. So the object WILL NOT be merged together. This method is optional because it does not make sense to all possible implementors of the interface. So it can happen that this method does nothing more or less than the cloneToPosition method. This method also enables to adopts the content of the object (the default is to adopt, otherwise the paramter has to be set to false)

Parameters:

position - the position the object is to be cloned after

adoptContent - indicated if the content of the object should be adopted

propertyKeysContainer - container for property keys used for cloning style, my be null

Throws:

CloneException - if the object could not be cloned.

cloneAfterThisPositions

void cloneAfterThisPositions(IDestinationPosition[] positions,
                             boolean adoptContent,
                             PropertyKeysContainer propertyKeysContainer)
                             throws CloneException

Clones the chosen object after the given positions. Does not return a reference. Between the given position and the newly created object there will be a paragraph to add some space betwwen them. So the object WILL NOT be merged together. This method is optional because it does not make sense to all possible implementors of the interface. So it can happen that this method does nothing more or less than the cloneToPosition method. This method also enables to adopts the content of the object (the default is to adopt, otherwise the paramter has to be set to false)

Parameters:

positions - the positions the object is to be cloned after

adoptContent - indicated if the content of the object should be adopted

propertyKeysContainer - container for property keys used for cloning style, my be null

Throws:

CloneException - if the object could not be cloned.