1 /******************************************************************************* 2 * Copyright (c) 2011, 2015 IBM Corporation and others. 3 * 4 * This program and the accompanying materials 5 * are made available under the terms of the Eclipse Public License 2.0 6 * which accompanies this distribution, and is available at 7 * https://www.eclipse.org/legal/epl-2.0/ 8 * 9 * SPDX-License-Identifier: EPL-2.0 10 * 11 * Contributors: 12 * IBM Corporation - initial API and implementation 13 *******************************************************************************/ 14 package org.eclipse.jface.dialogs; 15 16 /** 17 * IDialogLabelKeys contains publicly accessible keys to the common dialog 18 * labels used throughout JFace. <code>IDialogConstants</code> provides 19 * access to these labels using static constants. This is the preferred 20 * method when the client is optimizing for performance and is known to be 21 * used in a single-locale system. Using the keys and accessing the 22 * common dialog labels dynamically is the preferred method when the client 23 * may be running in a multi-locale system. 24 * 25 * @see IDialogConstants 26 * @since 3.7 27 * 28 * @noimplement This interface is not intended to be implemented by clients. 29 30 */ 31 public interface IDialogLabelKeys { 32 33 /** 34 * The key used to retrieve the label for OK buttons. Clients should use the pattern 35 * <code>JFaceResources.getString(IDialogLabelKeys.OK_LABEL_KEY)</code> to retrieve the label 36 * dynamically when using multiple locales. 37 * 38 * @since 3.7 39 */ 40 String OK_LABEL_KEY = "ok"; //$NON-NLS-1$ 41 42 /** 43 * The key used to retrieve the label for cancel buttons. 44 * Clients should use the pattern 45 * <code>JFaceResources.getString(IDialogLabelKeys.CANCEL_LABEL_KEY)</code> 46 * to retrieve the label dynamically when using multiple locales. 47 * @since 3.7 48 */ 49 String CANCEL_LABEL_KEY = "cancel"; //$NON-NLS-1$ 50 51 /** 52 * The key used to retrieve the label for yes buttons. 53 * Clients should use the pattern 54 * <code>JFaceResources.getString(IDialogLabelKeys.YES_LABEL_KEY)</code> 55 * to retrieve the label dynamically when using multiple locales. 56 * @since 3.7 57 */ 58 String YES_LABEL_KEY = "yes"; //$NON-NLS-1$ 59 60 /** 61 * The key used to retrieve the label for no buttons. 62 * Clients should use the pattern 63 * <code>JFaceResources.getString(IDialogLabelKeys.NO_LABEL_KEY)</code> 64 * to retrieve the label dynamically when using multiple locales. 65 * @since 3.7 66 */ 67 String NO_LABEL_KEY = "no"; //$NON-NLS-1$ 68 69 /** 70 * The key used to retrieve the label for no to all buttons. 71 * Clients should use the pattern 72 * <code>JFaceResources.getString(IDialogLabelKeys.NO_TO_ALL_LABEL_KEY)</code> 73 * to retrieve the label dynamically when using multiple locales. 74 * @since 3.7 75 */ 76 String NO_TO_ALL_LABEL_KEY = "notoall"; //$NON-NLS-1$ 77 78 /** 79 * The key used to retrieve the label for yes to all buttons. 80 * Clients should use the pattern 81 * <code>JFaceResources.getString(IDialogLabelKeys.YES_TO_ALL_LABEL_KEY)</code> 82 * to retrieve the label dynamically when using multiple locales. 83 * @since 3.7 84 */ 85 String YES_TO_ALL_LABEL_KEY = "yestoall"; //$NON-NLS-1$ 86 87 /** 88 * The key used to retrieve the label for skip buttons. 89 * Clients should use the pattern 90 * <code>JFaceResources.getString(IDialogLabelKeys.SKIP_LABEL_KEY)</code> 91 * to retrieve the label dynamically when using multiple locales. 92 * @since 3.7 93 */ 94 String SKIP_LABEL_KEY = "skip"; //$NON-NLS-1$ 95 96 /** 97 * The key used to retrieve the label for stop buttons. 98 * Clients should use the pattern 99 * <code>JFaceResources.getString(IDialogLabelKeys.STOP_LABEL_KEY)</code> 100 * to retrieve the label dynamically when using multiple locales. 101 * @since 3.7 102 */ 103 String STOP_LABEL_KEY = "stop"; //$NON-NLS-1$ 104 105 /** 106 * The key used to retrieve the label for abort buttons. 107 * Clients should use the pattern 108 * <code>JFaceResources.getString(IDialogLabelKeys.ABORT_LABEL_KEY)</code> 109 * to retrieve the label dynamically when using multiple locales. 110 * @since 3.7 111 */ 112 String ABORT_LABEL_KEY = "abort"; //$NON-NLS-1$ 113 114 /** 115 * The key used to retrieve the label for retry buttons. 116 * Clients should use the pattern 117 * <code>JFaceResources.getString(IDialogLabelKeys.RETRY_LABEL_KEY)</code> 118 * to retrieve the label dynamically when using multiple locales. 119 * @since 3.7 120 */ 121 String RETRY_LABEL_KEY = "retry"; //$NON-NLS-1$ 122 123 /** 124 * The key used to retrieve the label for ignore buttons. 125 * Clients should use the pattern 126 * <code>JFaceResources.getString(IDialogLabelKeys.IGNORE_LABEL_KEY)</code> 127 * to retrieve the label dynamically when using multiple locales. 128 * @since 3.7 129 */ 130 String IGNORE_LABEL_KEY = "ignore"; //$NON-NLS-1$ 131 132 /** 133 * The key used to retrieve the label for proceed buttons. 134 * Clients should use the pattern 135 * <code>JFaceResources.getString(IDialogLabelKeys.PROCEED_LABEL_KEY)</code> 136 * to retrieve the label dynamically when using multiple locales. 137 * @since 3.7 138 */ 139 String PROCEED_LABEL_KEY = "proceed"; //$NON-NLS-1$ 140 141 /** 142 * The key used to retrieve the label for open buttons. 143 * Clients should use the pattern 144 * <code>JFaceResources.getString(IDialogLabelKeys.OPEN_LABEL_KEY)</code> 145 * to retrieve the label dynamically when using multiple locales. 146 * @since 3.7 147 */ 148 String OPEN_LABEL_KEY = "open"; //$NON-NLS-1$ 149 150 /** 151 * The key used to retrieve the label for close buttons. 152 * Clients should use the pattern 153 * <code>JFaceResources.getString(IDialogLabelKeys.CLOSE_LABEL_KEY)</code> 154 * to retrieve the label dynamically when using multiple locales. 155 * @since 3.7 156 */ 157 String CLOSE_LABEL_KEY = "close"; //$NON-NLS-1$ 158 159 /** 160 * The key used to retrieve the label for show details buttons. 161 * Clients should use the pattern 162 * <code>JFaceResources.getString(IDialogLabelKeys.SHOW_DETAILS_LABEL_KEY)</code> 163 * to retrieve the label dynamically when using multiple locales. 164 * @since 3.7 165 */ 166 String SHOW_DETAILS_LABEL_KEY = "showDetails"; //$NON-NLS-1$ 167 168 /** 169 * The key used to retrieve the label for hide details buttons. 170 * Clients should use the pattern 171 * <code>JFaceResources.getString(IDialogLabelKeys.HIDE_DETAILS_LABEL_KEY)</code> 172 * to retrieve the label dynamically when using multiple locales. 173 * @since 3.7 174 */ 175 String HIDE_DETAILS_LABEL_KEY = "hideDetails"; //$NON-NLS-1$ 176 177 /** 178 * The key used to retrieve the label for back buttons. 179 * Clients should use the pattern 180 * <code>JFaceResources.getString(IDialogLabelKeys.BACK_LABEL_KEY)</code> 181 * to retrieve the label dynamically when using multiple locales. 182 * @since 3.7 183 */ 184 String BACK_LABEL_KEY = "backButton"; //$NON-NLS-1$ 185 186 /** 187 * The key used to retrieve the label for next buttons. 188 * Clients should use the pattern 189 * <code>JFaceResources.getString(IDialogLabelKeys.NEXT_LABEL_KEY)</code> 190 * to retrieve the label dynamically when using multiple locales. 191 * @since 3.7 192 */ 193 String NEXT_LABEL_KEY = "nextButton"; //$NON-NLS-1$ 194 195 /** 196 * The key used to retrieve the label for finish buttons. 197 * Clients should use the pattern 198 * <code>JFaceResources.getString(IDialogLabelKeys.FINISH_LABEL_KEY)</code> 199 * to retrieve the label dynamically when using multiple locales. 200 * @since 3.7 201 */ 202 String FINISH_LABEL_KEY = "finish"; //$NON-NLS-1$ 203 204 /** 205 * The key used to retrieve the label for help buttons. 206 * Clients should use the pattern 207 * <code>JFaceResources.getString(IDialogLabelKeys.HELP_LABEL_KEY)</code> 208 * to retrieve the label dynamically when using multiple locales. 209 * @since 3.7 210 */ 211 String HELP_LABEL_KEY = "help"; //$NON-NLS-1$ 212 } 213