ProblemDetailsImplementation (Refactoring API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.refactoring.api 1.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.refactoring.spi
Interface ProblemDetailsImplementation

public interface ProblemDetailsImplementation

Typical implementation will invoke UI component on showDetails() call This UI component will display ProblemDetails. There will be a button, or similar UI control, which will be connected to rerunRefactoringAction to invoke refactoring again once the Problem is fixed.

Since:: 1.5.0

Method Summary

String getDetailsHint()
Message that will be displayed in parameters panel as a hint to suggest user, that there are more details available.

void showDetails(Action rerunRefactoringAction, Cancellable parent)
This method will typically invoke component with ProblemDetails.

Method Summary
`String`	`getDetailsHint()` Message that will be displayed in parameters panel as a hint to suggest user, that there are more details available.
`void`	`showDetails(Action rerunRefactoringAction, Cancellable parent)` This method will typically invoke component with ProblemDetails.

Method Detail

showDetails

void showDetails(Action rerunRefactoringAction,
                 Cancellable parent)

This method will typically invoke component with ProblemDetails. It is fully upon clients, how this component will be implemented.

Parameters:: rerunRefactoringAction - this action is passed to client component; parent - parent component, than can be closed by cancel method. to allow clients to rerun refactoring once the Problem is fixed.

getDetailsHint

String getDetailsHint()

Message that will be displayed in parameters panel as a hint to suggest user, that there are more details available.

Returns:: string representation of details hint