RefactoringHistoryControlConfiguration (Eclipse Platform API Specification)

java.lang.Object
- org.eclipse.ltk.ui.refactoring.history.RefactoringHistoryControlConfiguration

```
public class RefactoringHistoryControlConfiguration
extends java.lang.Object
```
Configuration object for a refactoring history control.
Note: this class is intended to be subclassed by clients wishing to control the configuration behavior of their refactoring history control.

Since:

3.2

See Also:

RefactoringUI.createRefactoringHistoryControl(org.eclipse.swt.widgets.Composite, RefactoringHistoryControlConfiguration), IRefactoringHistoryControl, RefactoringHistoryLabelProvider, RefactoringHistoryContentProvider

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`fCheckable` Should the refactorings be checkable?
`protected IProject`	`fProject` The project, or `null` for the workspace
`protected boolean`	`fTime` Should time information be displayed?

Constructor Summary

Constructors
Constructor and Description
`RefactoringHistoryControlConfiguration(IProject project, boolean time, boolean checkable)` Creates a new refactoring history control configuration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCollectionLabel()` Returns the label of a collection of refactorings.
`java.lang.String`	`getCommentCaption()` Returns the text of the comment field below the refactoring history tree, if the currently selected refactoring descriptor provides no comment.
`RefactoringHistoryContentProvider`	`getContentProvider()` Returns the content provider to use.
`java.lang.String`	`getDayPattern()` Returns the message format pattern to use for days.
`RefactoringHistoryLabelProvider`	`getLabelProvider()` Returns the label provider to use.
`java.lang.String`	`getLastMonthPattern()` Returns the message format pattern to use for last month.
`java.lang.String`	`getLastWeekPattern()` Returns the message format pattern to use for last week.
`java.lang.String`	`getMonthPattern()` Returns the message format pattern to use for months.
`IProject`	`getProject()` Returns the project of the refactoring history being displayed.
`java.lang.String`	`getProjectPattern()` Returns the message format pattern to use if refactorings of exactly one project are displayed.
`java.lang.String`	`getRefactoringPattern()` Returns the message format pattern to use for refactorings.
`java.lang.String`	`getThisMonthPattern()` Returns the message format pattern to use for this month.
`java.lang.String`	`getThisWeekPattern()` Returns the message format pattern to use for this week.
`java.lang.String`	`getTodayPattern()` Returns the message format pattern to use for today.
`java.lang.String`	`getWeekPattern()` Returns the message format pattern to use for weeks.
`java.lang.String`	`getWorkspaceCaption()` Returns the caption of the refactoring history tree if refactorings of more than one project are displayed.
`java.lang.String`	`getYearPattern()` Returns the message format pattern to use for years.
`java.lang.String`	`getYesterdayPattern()` Returns the message format pattern to use for yesterday.
`boolean`	`isCheckableViewer()` Returns whether the control should make the refactorings checkable.
`boolean`	`isTimeDisplayed()` Returns whether the control should display time information.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - fCheckable
```
protected final boolean fCheckable
```
    Should the refactorings be checkable?
  - fProject
```
protected final IProject fProject
```
    The project, or null for the workspace
  - fTime
```
protected final boolean fTime
```
    Should time information be displayed?
- Constructor Detail
  - RefactoringHistoryControlConfiguration
```
public RefactoringHistoryControlConfiguration(IProject project,
                                              boolean time,
                                              boolean checkable)
```
    Creates a new refactoring history control configuration.
    
    Parameters:
    
    project - the project, or null for the workspace
    
    time - true to display time information, false otherwise
    
    checkable - true if the refactorings should be checkable, false otherwise
- Method Detail
  - getCollectionLabel
```
public java.lang.String getCollectionLabel()
```
    Returns the label of a collection of refactorings.
    
    Returns:
    
    the collection label
  - getCommentCaption
```
public java.lang.String getCommentCaption()
```
    Returns the text of the comment field below the refactoring history tree, if the currently selected refactoring descriptor provides no comment.
    
    Returns:
    
    the comment caption
  - getContentProvider
```
public RefactoringHistoryContentProvider getContentProvider()
```
    Returns the content provider to use.
    
    Returns:
    
    the content provider to use
  - getDayPattern
```
public java.lang.String getDayPattern()
```
    Returns the message format pattern to use for days.
    Arguments:
    - {0}: formatted date
    Returns:
    
    the day pattern
  - getLabelProvider
```
public RefactoringHistoryLabelProvider getLabelProvider()
```
    Returns the label provider to use.
    
    Returns:
    
    the label provider to use
  - getLastMonthPattern
```
public java.lang.String getLastMonthPattern()
```
    Returns the message format pattern to use for last month.
    Arguments:
    - {0}: month name
    Returns:
    
    the last month pattern
  - getLastWeekPattern
```
public java.lang.String getLastWeekPattern()
```
    Returns the message format pattern to use for last week.
    Arguments:
    - {0}: week number
    Returns:
    
    the last week pattern
  - getMonthPattern
```
public java.lang.String getMonthPattern()
```
    Returns the message format pattern to use for months.
    Arguments:
    - {0}: month name
    Returns:
    
    the month pattern
  - getProject
```
public final IProject getProject()
```
    Returns the project of the refactoring history being displayed.
    
    Returns:
    
    the project, or null for the workspace
  - getProjectPattern
```
public java.lang.String getProjectPattern()
```
    Returns the message format pattern to use if refactorings of exactly one project are displayed.
    Arguments:
    - {0}: name of project
    Returns:
    
    the project pattern
  - getRefactoringPattern
```
public java.lang.String getRefactoringPattern()
```
    Returns the message format pattern to use for refactorings.
    Arguments:
    - {0}: formatted date
    - {0}: description of refactoring
    Returns:
    
    the refactoring pattern
  - getThisMonthPattern
```
public java.lang.String getThisMonthPattern()
```
    Returns the message format pattern to use for this month.
    Arguments:
    - {0}: month name
    Returns:
    
    the this month pattern
  - getThisWeekPattern
```
public java.lang.String getThisWeekPattern()
```
    Returns the message format pattern to use for this week.
    Arguments:
    - {0}: week number
    Returns:
    
    the this week pattern
  - getTodayPattern
```
public java.lang.String getTodayPattern()
```
    Returns the message format pattern to use for today.
    Arguments:
    - {0}: formatted date
    Returns:
    
    the today pattern
  - getWeekPattern
```
public java.lang.String getWeekPattern()
```
    Returns the message format pattern to use for weeks.
    Arguments:
    - {0}: week number
    Returns:
    
    the week pattern
  - getWorkspaceCaption
```
public java.lang.String getWorkspaceCaption()
```
    Returns the caption of the refactoring history tree if refactorings of more than one project are displayed.
    
    Returns:
    
    the workspace caption
  - getYearPattern
```
public java.lang.String getYearPattern()
```
    Returns the message format pattern to use for years.
    Arguments:
    - {0}: year number
    Returns:
    
    the year pattern
  - getYesterdayPattern
```
public java.lang.String getYesterdayPattern()
```
    Returns the message format pattern to use for yesterday.
    Arguments:
    - {0}: formatted date
    Returns:
    
    the yesterday pattern
  - isCheckableViewer
```
public final boolean isCheckableViewer()
```
    Returns whether the control should make the refactorings checkable.
    
    Returns:
    
    true if the control should make refactorings checkable, false otherwise
  - isTimeDisplayed
```
public final boolean isTimeDisplayed()
```
    Returns whether the control should display time information.
    
    Returns:
    
    true to display time information, false otherwise

Class RefactoringHistoryControlConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fCheckable

fProject

fTime

Constructor Detail

RefactoringHistoryControlConfiguration

Method Detail

getCollectionLabel

getCommentCaption

getContentProvider

getDayPattern

getLabelProvider

getLastMonthPattern

getLastWeekPattern

getMonthPattern

getProject

getProjectPattern

getRefactoringPattern

getThisMonthPattern

getThisWeekPattern

getTodayPattern

getWeekPattern

getWorkspaceCaption

getYearPattern

getYesterdayPattern

isCheckableViewer

isTimeDisplayed