org.netbeans.spi.viewmodel

Interface TableHTMLModel

All Superinterfaces:

Model, TableModel

All Known Implementing Classes:

Models.CompoundModel

public interface TableHTMLModel
extends TableModel

Use this to separate value and the HTML value. When displaying a property value, then if the value is a String and if it contains a HTML code, it's automatically rendered as HTML. The HTML code is then stripped out to get the raw value. If this is not desired or if it's necessary to provide a value and HTML code that differs from each other, implement this model.

Since:

1.42

See Also:

TableHTMLModelFilter

Method Summary

Modifier and Type	Method and Description
String	getHTMLValueAt(Object node, String columnID) Get the HTML value.
boolean	hasHTMLValueAt(Object node, String columnID) Test if the model has a HTML value.

Methods inherited from interface org.netbeans.spi.viewmodel.TableModel

addModelListener, getValueAt, isReadOnly, removeModelListener, setValueAt

Method Detail

hasHTMLValueAt

boolean hasHTMLValueAt(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 TableHTMLModel.getHTMLValueAt(java.lang.Object, java.lang.String).

Parameters:

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 TableHTMLModel.getHTMLValueAt(java.lang.Object, java.lang.String), false otherwise. When false is returned, TableHTMLModel.getHTMLValueAt(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(Object node,
                      String columnID)
               throws UnknownTypeException

Get the HTML value.

Parameters:

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:

TableHTMLModel.hasHTMLValueAt(java.lang.Object, java.lang.String)