org.eclipse.mylyn.internal.wikitext.confluence.core.block
Class TextBoxBlock
java.lang.Object
org.eclipse.mylyn.wikitext.core.parser.markup.Processor
org.eclipse.mylyn.wikitext.core.parser.markup.Block
org.eclipse.mylyn.internal.wikitext.confluence.core.block.ParameterizedBlock
org.eclipse.mylyn.internal.wikitext.confluence.core.block.TextBoxBlock
- All Implemented Interfaces:
- Cloneable
public class TextBoxBlock
- extends ParameterizedBlock
- Author:
- David Green
Method Summary |
boolean |
beginNesting()
Indicate if block nesting should begin. |
boolean |
canStart(String line,
int lineOffset)
Indicate if the block can start with the given markup line at the provided offset. |
int |
findCloseOffset(String line,
int lineOffset)
Indicate if the block can close on the given line at the given offset. |
int |
processLineContent(String line,
int offset)
Process the given line of markup starting at the provided offset. |
void |
setClosed(boolean closed)
Cause the block to be closed. |
protected void |
setOption(String key,
String value)
Set an option with key and value pair |
TextBoxBlock
public TextBoxBlock(DocumentBuilder.BlockType blockType,
String name)
processLineContent
public int processLineContent(String line,
int offset)
- Description copied from class:
Block
- Process the given line of markup starting at the provided offset.
- Specified by:
processLineContent
in class Block
- Parameters:
line
- the markup line to processoffset
- the offset at which to start processing
- Returns:
- a non-negative integer to indicate that processing of the block completed before the end of the line, or
-1 if the entire line was processed.
beginNesting
public boolean beginNesting()
- Description copied from class:
Block
- Indicate if block nesting should begin. Called after
Block.processLineContent(String, int)
.
- Overrides:
beginNesting
in class Block
- Returns:
- true if nesting should start, otherwise false.
- See Also:
Block.findCloseOffset(String, int)
findCloseOffset
public int findCloseOffset(String line,
int lineOffset)
- Description copied from class:
Block
- Indicate if the block can close on the given line at the given offset. blocks that implement a nesting protocol
must implement this method.
- Overrides:
findCloseOffset
in class Block
- Parameters:
line
- the line of contentlineOffset
- the 0-based offset into the line
- Returns:
- the 0-based offset where the close will occur, or -1 if the block should not close on this line.
- See Also:
Block.beginNesting()
canStart
public boolean canStart(String line,
int lineOffset)
- Description copied from class:
Block
- Indicate if the block can start with the given markup line at the provided offset. Calling this method may cause
the block to have state which is propagated when
cloning
and consumed in
#processLine(String, int, int)
. Calling this method must cause any previous state to be reset. Note that
it is valid for block implementations to refuse to start at non-zero offsets.
Implementations must be able to handle this method without having the processor state
initialized.
- Specified by:
canStart
in class Block
- Parameters:
line
- the line of markup to testlineOffset
- the offset at which the block should start processing
- Returns:
- true if the provided markup consists of a valid starting point for the block
setClosed
public void setClosed(boolean closed)
- Description copied from class:
Block
- Cause the block to be closed. If the block is going from the open to the closed state, then the block must cause
the closed state to be propagated to the
builder
if necessary.
- Overrides:
setClosed
in class Block
setOption
protected void setOption(String key,
String value)
- Description copied from class:
ParameterizedBlock
- Set an option with key and value pair
- Specified by:
setOption
in class ParameterizedBlock
- Parameters:
key
- the key of the optionvalue
- the value of the option- See Also:
ParameterizedBlock.setOption(String)
Copyright © 2011 FuseSource, Corp.. All Rights Reserved.