org.netbeans.spi.debugger.ui

Class DebuggingView.DVFilter

java.lang.Object

org.netbeans.spi.debugger.ui.DebuggingView.DVFilter

Enclosing class:

DebuggingView

public static final class DebuggingView.DVFilter
extends Object

Boolean state filter that is applied to the debugging view. It's icon is made visible in the debugging view bottom panel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DebuggingView.DVFilter.DefaultFilter Pre-defined default filters enumeration.
static class	DebuggingView.DVFilter.Group The filter group.

Method Summary

Modifier and Type	Method and Description
static DebuggingView.DVFilter	create(String name, String displayName, String tooltip, Icon selectedIcon, Preferences valuePrefs, String valuePrefKey, boolean isSelectedDefault, DebuggingView.DVFilter.Group group) Create a custom filter.
static DebuggingView.DVFilter	getDefault(DebuggingView.DVFilter.DefaultFilter filter) Get an instance of a default filter.
String	getDisplayName() Get the filter display name.
DebuggingView.DVFilter.Group	getGroup() Get the filter group.
Icon	getIcon() Get the filter icon.
String	getName() Get the filter name.
Preferences	getPreferences() Get the filter preferences.
String	getPrefKey() Get the preference key.
String	getTooltip() Get the filter tooltip.
boolean	isSelected() Test if the filter is selected.
void	setSelected(boolean state) Set the filter as selected/unselected.

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static DebuggingView.DVFilter getDefault(DebuggingView.DVFilter.DefaultFilter filter)

Get an instance of a default filter.

Parameters:

filter - the default filter kind

Returns:

filter implementation

create

public static DebuggingView.DVFilter create(String name,
                                            String displayName,
                                            String tooltip,
                                            Icon selectedIcon,
                                            Preferences valuePrefs,
                                            String valuePrefKey,
                                            boolean isSelectedDefault,
                                            DebuggingView.DVFilter.Group group)

Create a custom filter.

Parameters:

name - name of the filter

displayName - display name of the filter (visible in an action menu)

tooltip - tool-tip of the filter

selectedIcon - icon of the filter

valuePrefs - preferences which are asked for the filter value

valuePrefKey - key that is used to retrieve the filter value from preferences

isSelectedDefault - whether the filter should be selected by default when preferences do not contain the value

group - a filter group, can be null

Returns:

implementation of the filter

getGroup

public DebuggingView.DVFilter.Group getGroup()

Get the filter group.

Returns:

the filter group, or null when the filter has no group

getName

public String getName()

Get the filter name.

Returns:

the filter name

getDisplayName

public String getDisplayName()

Get the filter display name.

Returns:

the filter display name

getTooltip

public String getTooltip()

Get the filter tooltip.

Returns:

the filter tooltip

getIcon

public Icon getIcon()

Get the filter icon.

Returns:

the filter icon

isSelected

public boolean isSelected()

Test if the filter is selected.

Returns:

whether the filter is selected right now

setSelected

public void setSelected(boolean state)

Set the filter as selected/unselected.

Parameters:

state - whether to select the filter

getPreferences

public Preferences getPreferences()

Get the filter preferences.

Returns:

the preferences of this filter

getPrefKey

public String getPrefKey()

Get the preference key.

Returns:

key that is used to retrieve the filter value from preferences