Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'org.eclipse.tips.core/src/org/eclipse/tips/core/TipAction.java')
-rw-r--r--org.eclipse.tips.core/src/org/eclipse/tips/core/TipAction.java81
1 files changed, 81 insertions, 0 deletions
diff --git a/org.eclipse.tips.core/src/org/eclipse/tips/core/TipAction.java b/org.eclipse.tips.core/src/org/eclipse/tips/core/TipAction.java
new file mode 100644
index 000000000..e73a2ac72
--- /dev/null
+++ b/org.eclipse.tips.core/src/org/eclipse/tips/core/TipAction.java
@@ -0,0 +1,81 @@
+/****************************************************************************
+ * Copyright (c) 2018 Remain Software
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Wim Jongman <wim.jongman@remainsoftware.com> - initial API and implementation
+ *****************************************************************************/
+package org.eclipse.tips.core;
+
+/**
+ * Provides an action to be executed by a Tip.
+ *
+ */
+public class TipAction {
+
+ private final String fText;
+ private final TipImage fTipImage;
+ private final Runnable fRunner;
+ private final String fTooltip;
+
+ /**
+ * Creates a new TipAction. Tip actions can be executed in the tip UI when the
+ * associated Tip is displayed.
+ *
+ * @param text
+ * a very short description to be used on buttons and menus.
+ * @param tooltip
+ * a longer description to be shown as tool tip when possible.
+ * @param runner
+ * the actual code to run
+ * @param image
+ * the image to be shown when possible.
+ *
+ */
+ public TipAction(String text, String tooltip, Runnable runner, TipImage image) {
+ fText = text;
+ fTooltip = tooltip;
+ fRunner = runner;
+ fTipImage = image;
+ }
+
+ /**
+ * The short description of the action to be shown as button text or menu entry
+ * when possible.
+ *
+ * @return the text
+ */
+ public String getText() {
+ return fText;
+ }
+
+ /**
+ * A longer description to be shown as tool tip when possible.
+ *
+ * @return the tool tip.
+ */
+ public String getTooltip() {
+ return fTooltip;
+ }
+
+ /**
+ * The icon of the image wrapped in a TipImage.
+ *
+ * @return the icon
+ */
+ public TipImage getTipImage() {
+ return fTipImage;
+ }
+
+ /**
+ * The actual code to run when this action is executed.
+ *
+ * @return the runner.
+ */
+ public Runnable getRunner() {
+ return fRunner;
+ }
+} \ No newline at end of file

Back to the top