org.netbeans.api.editor.guards

Class GuardedSectionManager

java.lang.Object

org.netbeans.api.editor.guards.GuardedSectionManager

public final class GuardedSectionManager
extends Object

This is the entry point for clients to manipulate guarded sections of the given document.

Method Summary

Modifier and Type	Method and Description
InteriorSection	createInteriorSection(Position pos, String name) Creates an empty interior section at the given position.
SimpleSection	createSimpleSection(Position pos, String name) Creates an empty simple section at the given position.
InteriorSection	findInteriorSection(String name) Tries to find the interior section of the given name.
SimpleSection	findSimpleSection(String name) Tries to find the simple section of the given name.
Iterable<GuardedSection>	getGuardedSections() Gets all sections.
static GuardedSectionManager	getInstance(StyledDocument doc) Gets the manager instance.
SimpleSection	protectSimpleRegion(Position start, Position end, String name) Creates a simple section from a region of code.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static GuardedSectionManager getInstance(StyledDocument doc)

Gets the manager instance.

Parameters:

doc - a document containing guarded sections

Returns:

the manager instance or null.

findSimpleSection

public SimpleSection findSimpleSection(String name)

Tries to find the simple section of the given name.

Parameters:

name - the name of the requested section

Returns:

the found guarded section or null if there is no section of the given name

findInteriorSection

public InteriorSection findInteriorSection(String name)

Tries to find the interior section of the given name.

Parameters:

name - the name of the looked-for section

Returns:

the found guarded section or null if there is no section of the given name

createSimpleSection

public SimpleSection createSimpleSection(Position pos,
                                         String name)
                                  throws IllegalArgumentException,
                                         BadLocationException

Creates an empty simple section at the given position. The position must not be within any existing guarded section and the passed name must not be registered for other already existing section. The created section will initially contain one space and a newline.

Returns:

SimpleSection instance that can be used for generating text into the protected region

Throws:

IllegalArgumentException - if either the name has been already used, or the position is inside another section or Java Element.

BadLocationException - if pos is outside of document's scope, or the document does not permit creating the guarded section.

protectSimpleRegion

public SimpleSection protectSimpleRegion(Position start,
                                         Position end,
                                         String name)
                                  throws IllegalArgumentException,
                                         BadLocationException

Creates a simple section from a region of code. The code region will become guarded as in the case of `initComponents' method in forms. The section name can be used to find the section and if the section is persisted, will be written into the output file. Unline GuardedSectionManager.createSimpleSection(javax.swing.text.Position, java.lang.String), this method is intended for marking existing text protected/guarded.

Use GuardedSection.removeSection() to remove the protection.

Parameters:

start - start of the protected text

end - end of text, exclusive.

name - name for the guarded section

Returns:

SimpleSection instance, to allow further manipulation with the protected content.

Throws:

IllegalArgumentException

BadLocationException

Since:

1.33

createInteriorSection

public InteriorSection createInteriorSection(Position pos,
                                             String name)
                                      throws IllegalArgumentException,
                                             BadLocationException

Creates an empty interior section at the given position. The position must not be within any existing guarded section and the passed name must not be registered to other already existing section. The created section will initially contain one space and a newline in all its parts (header, body and footer).

Returns:

InteriorSection instance that can be used for generating text into the protected region

Throws:

IllegalArgumentException - if either the name has been already used, or the position is inside another section or Java Element.

BadLocationException - if pos is outside of document's scope, or the document does not permit creating the guarded section.

getGuardedSections

public Iterable<GuardedSection> getGuardedSections()

Gets all sections.

Returns:

an iterable over GuardedSections