org.netbeans.spi.viewmodel

Interface TableHTMLModelFilter

All Superinterfaces:

Model

public interface TableHTMLModelFilter
extends Model

Use this to separate value and the HTML value. Implement this filter to override the behavior of any registered TableHTMLModels.

Since:

1.42

See Also:

TableHTMLModel

Method Summary

Modifier and Type	Method and Description
void	addModelListener(ModelListener l) Registers given listener.
String	getHTMLValueAt(TableHTMLModel original, Object node, String columnID) Get the HTML value.
boolean	hasHTMLValueAt(TableHTMLModel original, Object node, String columnID) Test if the model has a HTML value.
void	removeModelListener(ModelListener l) Unregisters given listener.

Method Detail

hasHTMLValueAt

boolean hasHTMLValueAt(TableHTMLModel original,
                       Object node,
                       String columnID)
                throws UnknownTypeException

Test if the model has a HTML value. For backward compatibility, if it returns false, HTML value is is taken from the String value, if it contains some. If this is not desired, return true here and null from TableHTMLModelFilter.getHTMLValueAt(org.netbeans.spi.viewmodel.TableHTMLModel, java.lang.Object, java.lang.String).

Parameters:

original - The original TableHTMLModel

node - an object returned from TreeModel.getChildren(java.lang.Object, int, int) for this row

columnID - an id of column defined by ColumnModel.getID()

Returns:

true if there is some HTML value to be returned from TableHTMLModelFilter.getHTMLValueAt(org.netbeans.spi.viewmodel.TableHTMLModel, java.lang.Object, java.lang.String), false otherwise. When false is returned, TableHTMLModelFilter.getHTMLValueAt(org.netbeans.spi.viewmodel.TableHTMLModel, java.lang.Object, java.lang.String) is not called.

Throws:

UnknownTypeException - if there is nothing to be provided for the given parameter type

getHTMLValueAt

String getHTMLValueAt(TableHTMLModel original,
                      Object node,
                      String columnID)
               throws UnknownTypeException

Get the HTML value.

Parameters:

original - The original TableHTMLModel

node - an object returned from TreeModel.getChildren(java.lang.Object, int, int) for this row

columnID - an id of column defined by ColumnModel.getID()

Returns:

The HTML value, or null when no HTML value is provided.

Throws:

UnknownTypeException - if there is nothing to be provided for the given parameter type

See Also:

TableHTMLModelFilter.hasHTMLValueAt(org.netbeans.spi.viewmodel.TableHTMLModel, java.lang.Object, java.lang.String)

addModelListener

void addModelListener(ModelListener l)

Registers given listener.

Parameters:

l - the listener to add

removeModelListener

void removeModelListener(ModelListener l)

Unregisters given listener.

Parameters:

l - the listener to remove