annotate dwtx/jface/fieldassist/SimpleContentProposalProvider.d @ 29:f12d40e7da8f

fieldassist
author Frank Benoit <benoit@tionex.de>
date Thu, 03 Apr 2008 18:56:20 +0200
parents
children 46a6e0e6ccd4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2005, 2006 IBM Corporation and others.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.fieldassist.SimpleContentProposalProvider;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwtx.jface.fieldassist.IContentProposalProvider;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwtx.jface.fieldassist.IContentProposal;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 import tango.util.collection.ArraySeq;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 import dwt.dwthelper.utils;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 /**
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * SimpleContentProposalProvider is a class designed to map a static list of
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * Strings to content proposals.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 *
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * @see IContentProposalProvider
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * @since 3.2
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 *
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 */
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 public class SimpleContentProposalProvider : IContentProposalProvider {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 /*
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * The proposals provided.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 */
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 private String[] proposals;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 /*
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * The proposals mapped to IContentProposal. Cached for speed in the case
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * where filtering is not used.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 */
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 private IContentProposal[] contentProposals;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 /*
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 * bool that tracks whether filtering is used.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 */
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 private bool filterProposals = false;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 /**
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * Construct a SimpleContentProposalProvider whose content proposals are
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * always the specified array of Objects.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 *
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * @param proposals
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * the array of Strings to be returned whenever proposals are
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * requested.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 */
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 public this(String[] proposals) {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 //super();
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 this.proposals = proposals;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 /**
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 * Return an array of Objects representing the valid content proposals for a
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * field. Ignore the current contents of the field.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 *
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * @param contents
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * the current contents of the field (only consulted if filtering
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 * is set to <code>true</code>)
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * @param position
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * the current cursor position within the field (ignored)
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * @return the array of Objects that represent valid proposals for the field
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 * given its current content.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 */
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 public IContentProposal[] getProposals(String contents, int position) {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 if (filterProposals) {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 auto list = new ArraySeq!(IContentProposal);
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 for (int i = 0; i < proposals.length; i++) {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 if (proposals[i].length > contents.length
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 && proposals[i].substring(0, contents.length)
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 .equalsIgnoreCase(contents)) {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 list.append(makeContentProposal(proposals[i]));
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 return list.toArray();
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 if (contentProposals is null) {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 contentProposals = new IContentProposal[proposals.length];
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 for (int i = 0; i < proposals.length; i++) {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 contentProposals[i] = makeContentProposal(proposals[i]);
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 return contentProposals;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 /**
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 * Set the Strings to be used as content proposals.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 *
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 * @param items
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 * the array of Strings to be used as proposals.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 */
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 public void setProposals(String[] items) {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 this.proposals = items;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 contentProposals = null;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 /**
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 * Set the bool that controls whether proposals are filtered according to
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 * the current field content.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 *
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 * @param filterProposals
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 * <code>true</code> if the proposals should be filtered to
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 * show only those that match the current contents of the field,
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 * and <code>false</code> if the proposals should remain the
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 * same, ignoring the field content.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 * @since 3.3
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 */
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 public void setFiltering(bool filterProposals) {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 this.filterProposals = filterProposals;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 // Clear any cached proposals.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 contentProposals = null;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 /*
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 * Make an IContentProposal for showing the specified String.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 */
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 private IContentProposal makeContentProposal( String proposal) {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126 return new class IContentProposal {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127 String proposal_;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128 this(){proposal_=proposal;}
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129 public String getContent() {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 return proposal_;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
133 public String getDescription() {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 return null;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 public String getLabel() {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
138 return null;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
139 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
140
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
141 public int getCursorPosition() {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
142 return proposal_.length;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
143 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
144 };
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145 }
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146 }