Package org.bukkit.block.sign

Interface SignSide

All Superinterfaces:

Colorable

public interface SignSide
extends Colorable

Represents a side of a sign.

Method Summary

Modifier and Type	Method	Description
String	getLine(int index)	Gets the line of text at the specified index on this side of the sign.
String[]	getLines()	Gets all the lines of text currently on this side of the sign.
boolean	isGlowingText()	Gets whether this side of the sign has glowing text.
void	setGlowingText(boolean glowing)	Sets whether this side of the sign has glowing text.
void	setLine(int index, String line)	Sets the line of text at the specified index on this side of the sign.

Methods inherited from interface org.bukkit.material.Colorable

getColor, setColor

Method Details

getLines

@NotNull
String[] getLines()

Gets all the lines of text currently on this side of the sign.

Returns:

Array of Strings containing each line of text

getLine

@NotNull
String getLine(int index)
        throws IndexOutOfBoundsException

Gets the line of text at the specified index on this side of the sign.

For example, getLine(0) will return the first line of text.

Parameters:

index - Line number to get the text from, starting at 0

Returns:

Text on the given line

Throws:

IndexOutOfBoundsException - Thrown when the line does not exist

setLine

void setLine(int index,
 @NotNull
 String line)
      throws IndexOutOfBoundsException

Sets the line of text at the specified index on this side of the sign.

For example, setLine(0, "Line One") will set the first line of text to "Line One".

Parameters:

index - Line number to set the text at, starting from 0

line - New text to set at the specified index

Throws:

IndexOutOfBoundsException - If the index is out of the range 0..3

isGlowingText

boolean isGlowingText()

Gets whether this side of the sign has glowing text.

Returns:

if this side of the sign has glowing text

setGlowingText

void setGlowingText(boolean glowing)

Sets whether this side of the sign has glowing text.

Parameters:

glowing - if this side of the sign has glowing text