hu.webarticum.chm

Class SampleDocument

java.lang.Object

hu.webarticum.chm.SampleDocument

public class SampleDocument
extends java.lang.Object

Demo document for demonstrating history management. Represents a list of characters. New characters can be inserted, and existing ones can be removed.

Constructor Summary

Constructors

Constructor and Description
SampleDocument(History history)

Method Summary

Modifier and Type	Method and Description
void	forceStatus(java.util.List<java.lang.Character> characters, int position) Forces inner status of the document Can be used for demonstrating Command.setExecuted().
void	forceStatus(java.lang.String content, int position) Forces inner status of the document
java.util.List<java.lang.Character>	getCharacters() Gets the characters of this document (the content).
History	getHistory() Gets the history manager of this document.
int	getPosition() Gets current position of internal pointer.
int	moveTo(int newPosition) Moves internal pointer to the given position.
int	moveToEnd() Moves internal pointer to end (length of document).
int	moveToStart() Moves internal pointer to begin (zero).
boolean	printChar(char character) Inserts a character at position of internal pointer.
boolean	printChars(char... characters) Inserts multiple characters at position of internal pointer.
boolean	removeChar() Removes character before the current position of internal pointer.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleDocument

public SampleDocument(History history)

Parameters:

history - the history manager for handling commands

Method Detail

getHistory

public History getHistory()

Gets the history manager of this document.

Returns:

the history manager

moveTo

public int moveTo(int newPosition)

Moves internal pointer to the given position. If less than zero, then will be corrected to zero. If greater then length of document, will be corrected to the length

Parameters:

newPosition - the new position of the internal pointer

moveToStart

public int moveToStart()

Moves internal pointer to begin (zero).

moveToEnd

public int moveToEnd()

Moves internal pointer to end (length of document).

removeChar

public boolean removeChar()

Removes character before the current position of internal pointer. Operation will fail if current position is zero.

Returns:

true on success

printChar

public boolean printChar(char character)

Inserts a character at position of internal pointer.

Returns:

true on success

printChars

public boolean printChars(char... characters)

Inserts multiple characters at position of internal pointer.

Returns:

true on success

getCharacters

public java.util.List<java.lang.Character> getCharacters()

Gets the characters of this document (the content).

Returns:

characters of this document

getPosition

public int getPosition()

Gets current position of internal pointer.

Returns:

position of internal pointer

forceStatus

public void forceStatus(java.lang.String content,
                        int position)

Forces inner status of the document

Parameters:

content - string of characters, see the other version

position - new position of the pointer

forceStatus

public void forceStatus(java.util.List<java.lang.Character> characters,
                        int position)

Forces inner status of the document Can be used for demonstrating Command.setExecuted().

Parameters:

characters - the new character list

position - new position of the pointer

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object