ag.ion.bion.officelayer.internal.text
Class ParagraphCloneService

java.lang.Object
  ag.ion.bion.officelayer.internal.clone.AbstractCloneService
      ag.ion.bion.officelayer.internal.text.ParagraphCloneService

All Implemented Interfaces:

ICloneService

public class ParagraphCloneService
extends AbstractCloneService

Concrete implementation of the CloneService for paragraphs.

Constructor Summary

ParagraphCloneService(IParagraph paragraph, ITextDocument document)
Constructs the ParagraphCloneService

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.
IClonedObject	cloneToPosition(IDestinationPosition range, boolean adoptContent, PropertyKeysContainer propertyKeysContainer) Clones the chosen paragraph to the given position and then returns a reference This method also enables to adopts the content of the paragraph (the default is to adopt, otherwise the paramter has to be set to false)
IClonedObject	cloneToPosition(IDestinationPosition range, PropertyKeysContainer propertyKeysContainer) Clones the paragraph 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.

Methods inherited from class ag.ion.bion.officelayer.internal.clone.AbstractCloneService

cloneAfterThisPositions, cloneAfterThisPositions, cloneToPositions, cloneToPositions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParagraphCloneService

public ParagraphCloneService(IParagraph paragraph,
                             ITextDocument document)
                      throws CloneException

Constructs the ParagraphCloneService

Parameters:

paragraph - paragraph to be used

document - document to be used

Throws:

CloneException - if any error occurs

Method Detail

cloneToPosition

public IClonedObject cloneToPosition(IDestinationPosition range,
                                     PropertyKeysContainer propertyKeysContainer)
                              throws CloneException

Clones the paragraph to the given position and then returns a reference. If the position is null, then the clone is placed at the end of the document.

Parameters:

range - range to be used

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

public 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.

cloneToPosition

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

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

Parameters:

range - range to be used

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

public 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.

cloneAfterThisPosition

public 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 - position to be used

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

public 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.

cloneAfterThisPosition

public 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 - position to be used

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

public 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.