App Inventor Extensions: Clipboard Manager

Clipboard Extension

See the App Inventor Extensions document about how to use an App Inventor Extension.

For questions about this extension or bug reports please start a new thread in the App Inventor community. Thank you.

For feature requests please contact me by email. To be a sponsor of a new method already is possible starting from only 10 USD! With your contribution you will help the complete App Inventor community. Thank you.

Aug 11th, 2016: Version 1a: avoid DX execution failed error: build each extension separately

Description

Clipboard Extension to copy text to or paste text from the clipboard.
Required permission: none

Properties

Returns whether the toast message should be suppressed. Default is false.

Specifies whether the toast message should be suppressed.

Methods

Copy text to clipboard.
In case SuppressToast is true, the toast message "Text copied" will be suppressed after copying a text to the clipboard.

Paste text from clipboard.
In case SuppressToast is true, the toast message "Text pasted" will be suppressed after pasting a text from the clipboard.

Example Use

For questions about App Inventor,
please ask in the App Inventor community.Thank you.

Java source code

package com.puravidaapps;

import android.content.Context;
import android.util.Log;
import android.widget.Toast;
import android.content.ClipData;
import android.content.ClipboardManager;
import android.content.Intent;
import android.content.res.AssetFileDescriptor;
import android.net.Uri;

import com.google.appinventor.components.annotations.DesignerComponent;
import com.google.appinventor.components.annotations.DesignerProperty;
import com.google.appinventor.components.annotations.PropertyCategory;
import com.google.appinventor.components.annotations.SimpleFunction;
import com.google.appinventor.components.annotations.SimpleObject;
import com.google.appinventor.components.annotations.SimpleProperty;
import com.google.appinventor.components.common.ComponentCategory;
import com.google.appinventor.components.common.PropertyTypeConstants;
import com.google.appinventor.components.runtime.*;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStreamReader;

@DesignerComponent(version = TaifunClipboard.VERSION,
    description = "Clipboard Manager Extension.",
    category = ComponentCategory.EXTENSION,
    nonVisible = true,
    iconName = "https://puravidaapps.com/images/taifun16.png")
@SimpleObject(external = true)
@SuppressWarnings("deprecation")

public class TaifunClipboard extends AndroidNonvisibleComponent implements Component {

  public static final int VERSION = 1;
  private ComponentContainer container;
  private Context context;
  private static final String LOG_TAG = "TaifunCM";
  private boolean suppressToast;


  public TaifunClipboard(ComponentContainer container) {
    super(container.$form());
    this.container = container;
    context = (Context) container.$context();
    Log.d(LOG_TAG, "TaifunClipboard Created");
  }


  /**
   * Returns whether Success Toast should be suppressed
   */
  @SimpleProperty(category = PropertyCategory.BEHAVIOR,
      description = "whether Success Toast should be suppressed")
  public boolean SuppressToast() {
    return suppressToast;
  }


  /**
   * Specifies whether Success Toast should be suppressed
   */
  @DesignerProperty(editorType = PropertyTypeConstants.PROPERTY_TYPE_BOOLEAN,
      defaultValue = "false")
  @SimpleProperty
  public void SuppressToast(boolean suppressToast) {
    this.suppressToast = suppressToast;
  }


  /**
   * The Copy method
   * http://stackoverflow.com/a/19253877/1545993 and http://stackoverflow.com/a/28780585/1545993
   *
   * @param text =  the text to copy
   */
  @SimpleFunction(description = "Copy text to clipboard. In case SuppressToast is true, the toast message " +
    "'Text copied' will be suppressed after copying a text to the clipboard.")
  public void Copy(String text) {
    try {
      int sdk = android.os.Build.VERSION.SDK_INT;
      if (sdk < android.os.Build.VERSION_CODES.HONEYCOMB) {
        android.text.ClipboardManager clipboard = (android.text.ClipboardManager) context.getSystemService(Context.CLIPBOARD_SERVICE);
        clipboard.setText(text);
      } else {
        android.content.ClipboardManager clipboard = (android.content.ClipboardManager) context.getSystemService(Context.CLIPBOARD_SERVICE);
        android.content.ClipData clip = android.content.ClipData.newPlainText("Copied text", text);
        clipboard.setPrimaryClip(clip);
      }
      Log.d(LOG_TAG, "Text copied: " + text);
      if (!suppressToast) {
        Toast.makeText(context, "Text copied.", Toast.LENGTH_SHORT).show();
      }
    } catch (Exception e) {
      Log.e(LOG_TAG, e.getMessage(), e);
    }
  }


  /**
   * The Paste method
   * http://stackoverflow.com/a/19253877/1545993
   */
  @SimpleFunction(description = "Paste text from clipboard. In case SuppressToast is true, the toast message " +
    "'Text pasted' will be suppressed after pasting a text from the clipboard.")
  public String Paste() {
    int sdk = android.os.Build.VERSION.SDK_INT;
    if (sdk < android.os.Build.VERSION_CODES.HONEYCOMB) {
      android.text.ClipboardManager clipboard = (android.text.ClipboardManager) context.getSystemService(Context.CLIPBOARD_SERVICE);
      return clipboard.getText().toString();
    } else {
      ClipboardManager clipboard = (ClipboardManager) context.getSystemService(Context.CLIPBOARD_SERVICE);

      // Gets the clipboard data from the clipboard
      ClipData clip = clipboard.getPrimaryClip();
      if (clip != null) {
        String text = null;

        // Gets the first item from the clipboard data
        ClipData.Item item = clip.getItemAt(0);

        // If the contents of the clipboard wasn't a reference to a note, then this converts whatever it is to text.
        if (text == null) {
          text = CoerceToText(item).toString();
        }

        Log.d(LOG_TAG, "Text pasted: " + text);
        if (!suppressToast) {
          Toast.makeText(context, "Text pasted.", Toast.LENGTH_SHORT).show();
        }
        return text;
      }
    }
    return "";
  }

  private CharSequence CoerceToText(ClipData.Item item) {
    // If this Item has an explicit textual value, simply return that.
    CharSequence text = item.getText();
    if (text != null) {
      return text;
    }

    // If this Item has a URI value, try using that.
    Uri uri = item.getUri();
    if (uri != null) {
      // First see if the URI can be opened as a plain text stream (of any sub-type). If so, this is the best textual representation for it.
      FileInputStream stream = null;
      try {
        // Ask for a stream of the desired type.
        AssetFileDescriptor descr = context.getContentResolver().openTypedAssetFileDescriptor(uri, "text/*", null);
        stream = descr.createInputStream();
        InputStreamReader reader = new InputStreamReader(stream, "UTF-8");

        // Got it... copy the stream into a local string and return it.
        StringBuilder builder = new StringBuilder(128);
        char[] buffer = new char[8192];
        int len;
        while ((len = reader.read(buffer)) > 0) {
          builder.append(buffer, 0, len);
        }
        return builder.toString();
      } catch (FileNotFoundException e) {
        // Unable to open content URI as text... not really an error, just something to ignore.
        Log.d(LOG_TAG, "Unable to open content URI as text, ignoring... " +  e.getMessage(), e);
      } catch (IOException e) {
        // Something bad has happened.
        Log.w(LOG_TAG, "Failure loading text", e);
        return e.toString();
      } finally {
        if (stream != null) {
          try {
            stream.close();
          } catch (IOException e) {
            Log.e(LOG_TAG, e.getMessage(), e);
        }
      }
    }

    // If we couldn't open the URI as a stream, then the URI itself probably serves fairly well as a textual representation.
    Log.d(LOG_TAG, "Couldn't open the URI as a stream, then the URI itself probably serves fairly well as a textual representation");
    return uri.toString();
  }

  // Finally, if all we have is an Intent, then we can just turn that into text. Not the most user-friendly thing, but it's something.
  Intent intent = item.getIntent();
  if (intent != null) {
    Log.d(LOG_TAG, "all we have is an Intent, then we can just turn that into text");
    return intent.toUri(Intent.URI_INTENT_SCHEME);
  }

  // Shouldn't get here, but just in case...
  return "";
  }

}

Terms and Conditions

Have fun and use this extension in your App Inventor projects! Pura Vida!
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
This is is the only authorized place to download this extension. It is not allowed to host this extension somewhere else and offer it for others to download, be it on another website or market place or similar. The reason is, everybody should be able to have the opportunity to donate something in case you like my work. You are allowed to provide a link to this site, so others can download the extension here. You will find the most up to date version always here including documentation and usage examples. Thank you for your kind understanding.

Download

Developing and maintaining snippets, tutorials and extensions for App Inventor takes a lot of time.
I hope it saved some of your time. If yes, then you might consider to donate a small amount!

or donate some mBTC to Bitcoin Address:
1Jd8kXLHu2Vkuhi15TWHiQm4uE9AGPYxi8
Bitcoin

Thank you! Taifun

Download TaifunClipboard extension (aix file)
Back to top of page ...

This work by Pura Vida Apps is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License
with attribution (name=Pura Vida Apps and link to the source site) required.

App Inventor Extensions

Clipboard Extension

Description

Properties

Methods

Example Use

For questions about App Inventor,please ask in the App Inventor community.Thank you.

Java source code

Terms and Conditions

Download

For questions about App Inventor,
please ask in the App Inventor community.Thank you.