org.gjt.sp.jedit
Class Mode

java.lang.Object
  org.gjt.sp.jedit.Mode

public class Mode
extends java.lang.Object

An edit mode defines specific settings for editing some type of file. One instance of this class is created for each supported edit mode.

Field Summary

protected TokenMarker	marker
protected java.lang.String	name
protected java.util.Map<java.lang.String,java.lang.Object>	props

Constructor Summary

Mode(java.lang.String name)
Creates a new edit mode.

Method Summary

boolean	accept(java.lang.String fileName, java.lang.String firstLine) Returns true if the edit mode is suitable for editing the specified file.
boolean	acceptFilename(java.lang.String fileName) Returns true if the buffer name matches the file name glob.
boolean	acceptFirstLine(java.lang.String firstLine) Returns true if the first line matches the first line glob.
boolean	getBooleanProperty(java.lang.String key) Returns the value of a boolean property.
boolean	getIgnoreWhitespace()
java.util.List<IndentRule>	getIndentRules()
java.lang.String	getName() Returns the internal name of this edit mode.
java.lang.Object	getProperty(java.lang.String key) Returns a mode property.
TokenMarker	getTokenMarker() Returns the token marker for this mode.
void	init() Initializes the edit mode.
boolean	isElectricKey(char ch)
void	loadIfNecessary() Loads the mode from disk if it hasn't been loaded already.
void	setProperties(java.util.Map props) Should only be called by XModeHandler.
void	setProperty(java.lang.String key, java.lang.Object value) Sets a mode property.
void	setTokenMarker(TokenMarker marker) Sets the token marker for this mode.
java.lang.String	toString() Returns a string representation of this edit mode.
void	unsetProperty(java.lang.String key) Unsets a mode property.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

props

protected java.util.Map<java.lang.String,java.lang.Object> props

marker

protected TokenMarker marker

Constructor Detail

Mode

public Mode(java.lang.String name)

Creates a new edit mode.

Parameters:

name - The name used in mode listings and to query mode properties

See Also:

getProperty(String)

Method Detail

init

public void init()

Initializes the edit mode. Should be called after all properties are loaded and set.

getTokenMarker

public TokenMarker getTokenMarker()

Returns the token marker for this mode.

setTokenMarker

public void setTokenMarker(TokenMarker marker)

Sets the token marker for this mode.

Parameters:

marker - The new token marker

loadIfNecessary

public void loadIfNecessary()

Loads the mode from disk if it hasn't been loaded already.

Since:

jEdit 2.5pre3

getProperty

public java.lang.Object getProperty(java.lang.String key)

Returns a mode property.

Parameters:

key - The property name

Since:

jEdit 2.2pre1

getBooleanProperty

public boolean getBooleanProperty(java.lang.String key)

Returns the value of a boolean property.

Parameters:

key - The property name

Since:

jEdit 2.5pre3

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Sets a mode property.

Parameters:

key - The property name

value - The property value

unsetProperty

public void unsetProperty(java.lang.String key)

Unsets a mode property.

Parameters:

key - The property name

Since:

jEdit 3.2pre3

setProperties

public void setProperties(java.util.Map props)

Should only be called by XModeHandler.

Since:

jEdit 4.0pre3

accept

public boolean accept(java.lang.String fileName,
                      java.lang.String firstLine)

Returns true if the edit mode is suitable for editing the specified file. The buffer name and first line is checked against the file name and first line globs, respectively.

Parameters:

fileName - The buffer's name

firstLine - The first line of the buffer

Since:

jEdit 3.2pre3

acceptFilename

public boolean acceptFilename(java.lang.String fileName)

Returns true if the buffer name matches the file name glob.

Parameters:

fileName - The buffer's name

Returns:

true if the file name matches the file name glob.

Since:

jEdit 4.3pre18

acceptFirstLine

public boolean acceptFirstLine(java.lang.String firstLine)

Returns true if the first line matches the first line glob.

Parameters:

firstLine - The first line of the buffer

Returns:

true if the first line matches the first line glob.

Since:

jEdit 4.3pre18

getName

public java.lang.String getName()

Returns the internal name of this edit mode.

toString

public java.lang.String toString()

Returns a string representation of this edit mode.

Overrides:

toString in class java.lang.Object

getIgnoreWhitespace

public boolean getIgnoreWhitespace()

getIndentRules

public java.util.List<IndentRule> getIndentRules()

isElectricKey

public boolean isElectricKey(char ch)