Skip to content

Add filter text support in Templates part in preference pages #3443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 3, 2025
+97 −36
Merged

Add filter text support in Templates part in preference pages #3443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 94 additions & 36 deletions ....workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatePreferencePage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@
import org.eclipse.jface.viewers.ColumnPixelData;
import org.eclipse.jface.viewers.ColumnWeightData;
import org.eclipse.jface.viewers.IBaseLabelProvider;
import org.eclipse.jface.viewers.IStructuredContentProvider;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.ITableLabelProvider;
import org.eclipse.jface.viewers.LabelProvider;
Expand All @@ -96,6 +97,7 @@
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerComparator;
import org.eclipse.jface.viewers.ViewerFilter;
import org.eclipse.jface.window.Window;

import org.eclipse.jface.text.Document;
Expand Down Expand Up @@ -152,6 +154,8 @@ public abstract class TemplatePreferencePage extends PreferencePage implements I
*
* @since 3.3
*/
private final Map<String, Boolean> checkedStates = new HashMap<>();

protected static class EditTemplateDialog extends StatusDialog {

private final Template fOriginalTemplate;
Expand Down Expand Up @@ -796,38 +800,45 @@ public void setContextTypeRegistry(ContextTypeRegistry registry) {
public void init(IWorkbench workbench) {
}

private String getKey(TemplatePersistenceData data) {
return data.getTemplate().getName() + "|" + data.getTemplate().getContextTypeId(); //$NON-NLS-1$
}

@Override
protected Control createContents(Composite ancestor) {
Composite parent= new Composite(ancestor, SWT.NONE);
GridLayout layout= new GridLayout();
layout.numColumns= 2;
layout.marginHeight= 0;
layout.marginWidth= 0;
parent.setLayout(layout);

Composite innerParent= new Composite(parent, SWT.NONE);
GridLayout innerLayout= new GridLayout();
innerLayout.numColumns= 2;
innerLayout.marginHeight= 0;
innerLayout.marginWidth= 0;
innerParent.setLayout(innerLayout);
GridData gd= new GridData(GridData.FILL_BOTH);
gd.horizontalSpan= 2;
innerParent.setLayoutData(gd);

Composite tableComposite= new Composite(innerParent, SWT.NONE);
GridData data= new GridData(GridData.FILL_BOTH);
data.widthHint= 360;
data.heightHint= convertHeightInCharsToPixels(10);
tableComposite.setLayoutData(data);

ColumnLayout columnLayout= new ColumnLayout();
Composite parent = new Composite(ancestor, SWT.NONE);
parent.setLayout(new GridLayout(1, false));

Composite tcomposite = new Composite(parent, SWT.NONE);
tcomposite.setLayout(new GridLayout(2, false));
tcomposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));

Composite fcomposite = new Composite(tcomposite, SWT.NONE);
fcomposite.setLayout(new GridLayout(1, false));
fcomposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));

Text filterText = new Text(fcomposite, SWT.BORDER | SWT.SEARCH | SWT.ICON_CANCEL);
filterText.setMessage(TemplatesMessages.TemplatePreferencePage_filterText);
GridData filterData = new GridData(SWT.FILL, SWT.CENTER, true, false);
filterData.widthHint = 360;
filterText.setLayoutData(filterData);

Composite tableComposite = new Composite(fcomposite, SWT.NONE);
GridData tableData = new GridData(SWT.FILL, SWT.FILL, true, true);
tableData.widthHint = 360;
tableData.heightHint = convertHeightInCharsToPixels(10);
tableComposite.setLayoutData(tableData);

ColumnLayout columnLayout = new ColumnLayout();
tableComposite.setLayout(columnLayout);
Table table= new Table(tableComposite, SWT.CHECK | SWT.BORDER | SWT.MULTI | SWT.FULL_SELECTION | SWT.H_SCROLL | SWT.V_SCROLL);
Table table = new Table(tableComposite,
SWT.CHECK | SWT.BORDER | SWT.MULTI | SWT.FULL_SELECTION | SWT.H_SCROLL | SWT.V_SCROLL);

table.setHeaderVisible(true);
table.setLinesVisible(true);

table.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));

GC gc= new GC(getShell());
gc.setFont(JFaceResources.getDialogFont());

Expand Down Expand Up @@ -877,18 +888,52 @@ protected Control createContents(Composite ancestor) {
fTableViewer.addCheckStateListener(event -> {
TemplatePersistenceData d = (TemplatePersistenceData) event.getElement();
d.setEnabled(event.getChecked());
checkedStates.put(getKey(d), event.getChecked());
});

BidiUtils.applyTextDirection(fTableViewer.getControl(), BidiUtils.BTD_DEFAULT);

Composite buttons= new Composite(innerParent, SWT.NONE);
buttons.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_BEGINNING));
layout= new GridLayout();
layout.marginHeight= 0;
layout.marginWidth= 0;
buttons.setLayout(layout);
TemplateFilter filter = new TemplateFilter();
fTableViewer.addFilter(filter);

filterText.addModifyListener(e -> {
filter.setSearchText(filterText.getText());
for (Object element : fTableViewer.getCheckedElements()) {
if (element instanceof TemplatePersistenceData data) {
String key = getKey(data);
checkedStates.put(key, true);
}
}
for (Object element : ((IStructuredContentProvider) fTableViewer.getContentProvider())
.getElements(fTableViewer.getInput())) {
if (element instanceof TemplatePersistenceData data) {
String key = getKey(data);
if (!fTableViewer.getChecked(data)) {
checkedStates.putIfAbsent(key, false);
}
}
}
fTableViewer.refresh();

for (Object element : ((IStructuredContentProvider) fTableViewer.getContentProvider())
.getElements(fTableViewer.getInput())) {
if (element instanceof TemplatePersistenceData data) {
Boolean checked = checkedStates.get(getKey(data));
if (checked != null && checked) {
fTableViewer.setChecked(data, true);
}
}
}
});

Composite buttons = new Composite(tcomposite, SWT.NONE);
buttons.setLayoutData(new GridData(SWT.FILL, SWT.TOP, false, false));
GridLayout buttonLayout = new GridLayout();
buttonLayout.marginHeight = 0;
buttonLayout.marginWidth = 0;
buttons.setLayout(buttonLayout);

fAddButton= new Button(buttons, SWT.PUSH);
fAddButton = new Button(buttons, SWT.PUSH);
fAddButton.setText(TemplatesMessages.TemplatePreferencePage_new);
fAddButton.setLayoutData(getButtonGridData(fAddButton));
fAddButton.addListener(SWT.Selection, e -> add());
Expand Down Expand Up @@ -932,9 +977,7 @@ protected Control createContents(Composite ancestor) {
if (isShowFormatterSetting()) {
fFormatButton= new Button(parent, SWT.CHECK);
fFormatButton.setText(TemplatesMessages.TemplatePreferencePage_use_code_formatter);
GridData gd1= new GridData();
gd1.horizontalSpan= 2;
fFormatButton.setLayoutData(gd1);
fFormatButton.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, false, false));
fFormatButton.setSelection(getPreferenceStore().getBoolean(getFormatterPreferenceKey()));
}

Expand All @@ -944,11 +987,26 @@ protected Control createContents(Composite ancestor) {

updateButtons();
Dialog.applyDialogFont(parent);
innerParent.layout();

return parent;
}

class TemplateFilter extends ViewerFilter {
private String searchString = ""; //$NON-NLS-1$
public void setSearchText(String s) {
searchString = (s == null) ? "" : s.toLowerCase(); //$NON-NLS-1$
}
@Override
public boolean select(Viewer viewer, Object parentElement, Object element) {
if (searchString.isEmpty())
return true;
Template template = ((TemplatePersistenceData) element).getTemplate();
return template.getName().toLowerCase().contains(searchString)
|| template.getContextTypeId().toLowerCase().contains(searchString)
|| template.getDescription().toLowerCase().contains(searchString);
}
}

/*
* @since 3.2
*/
Expand Down
1 change: 1 addition & 0 deletions ...se.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatesMessages.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ private TemplatesMessages() {
public static String TemplatesPage_remove_title_single;
public static String TemplatesPage_remove_title_multi;
public static String TemplatesView_no_templates;
public static String TemplatePreferencePage_filterText;

static {
NLS.initializeMessages(BUNDLE_NAME, TemplatesMessages.class);
Expand Down
2 changes: 2 additions & 0 deletions ...workbench.texteditor/src/org/eclipse/ui/texteditor/templates/TemplatesMessages.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ TemplatePreferencePage_question_create_new_button_rename= Rename Existing

TemplatePreferencePage_preview=Previe&w:

TemplatePreferencePage_filterText=type filter text

# edit template dialog
EditTemplateDialog_error_noname=Template name cannot be empty.
EditTemplateDialog_error_adjacent_variables=Template pattern has adjacent variables.
Expand Down
Loading