net.sf.jaxme.js
Interface PlaceHolder

public interface PlaceHolder

Interface of a placeholder. A placeholder is used by one method to note, that another method should insert code "here". A placeholder is created by invoking IndentationEngine.newPlaceHolder(String, boolean).

Author:

Jochen Wiedmann

Method Summary

int	getLevel() Returns the placeholders indentation level.
java.lang.String	getName() Returns the placeholders name.
java.lang.Object	getProperty(java.lang.String pName) Returns a property value.
boolean	isAutoRemovable() Returns whether the placeholder is automatically removable.
void	remove() Removes the placeholder.
void	setProperty(java.lang.String pName, java.lang.Object pValue) Sets a property.

Method Detail

getName

public java.lang.String getName()

Returns the placeholders name.

isAutoRemovable

public boolean isAutoRemovable()

Returns whether the placeholder is automatically removable.

remove

public void remove()

Removes the placeholder. If a placeholder isn't automatically removable, then it must be removed by an explicit invocation of this method.

setProperty

public void setProperty(java.lang.String pName,
                        java.lang.Object pValue)

Sets a property.

getProperty

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

Returns a property value. There is no distinction between the property value null and the case where the property isn't set.

getLevel

public int getLevel()

Returns the placeholders indentation level.