PoorEdit


Source link: https://github.com/SpongeBobSun/PoorEdit

PoorEdit

Rich Text Editor for Android

Status

WIP. So those who forked this repo may need to merge my code manually.

Buggy but almost there!

Screenshots

I'm tring to make it look & feel like you are still in Evernote



Features

  • Basic text editing
  • Bold
  • Italic
  • Underline
  • Highlight
  • Strike through
  • Images
  • File attachments
  • Todo lists
  • Lists
  • JSON export
  • JSON import

Usage

Setup

This project is still working in progress and I do NOT recommend using it in production env.

After check out this repo, you will get a test project and PoorEdit widget is located in pooredit folder. Import this folder as module in Android Studio.

Put below code in your layout xml file.

<sun.bob.pooredit.PoorEdit
  android:layout_width="match_parent"
  android:layout_height="match_parent"
  android:id="@+id/id_poor_edit"/>

And in the Activity which contains this widget, you may need to override onActivityResult function as below.

@Override protected void onActivityResult(int requestCode, int resultCode, Intent data){

  poorEdit.onActivityResult(requestCode, resultCode, data);

  //Write your code below. 
}

The reason for that is PoorEdit need to start image picking or file picking activities and it will require picking result after those activities finished.

That's all you need to do to initialize a shinny tinny rich editor.

Export & Import

PoorEdit support json export and import.

You can take the sample project as reference or use below two functions.

PoorEdit.exportJSON(String jsonFolder) PoorEdit.loadJson(String jsonFolder)

Both functions require an string arguement which is the folder where the json file will be.

PoorEdit will create a content.json in that folder. The reason why we need a folder is, I think you may want to copy files, images and other stuff in editor to one folder. That's make the folder a notebook, which you can upload those files to a webserver or something. Notice, PoorEdit dose NOT contains the upload part. It even doesn't require an Internet permission.

Below is the complete import & export code in sample project.

@Override
  public boolean onOptionsItemSelected(MenuItem item) {

int id = item.getItemId();

//Do the export.

if (id == R.id.action_exp) {

 ((PoorEdit) findViewById(R.id.id_poor_edit)).exportJSON("/sdcard/pooredit/debug/");

 return true;

}

//Do the import.

if (id == R.id.action_imp){

 ((PoorEdit) findViewById(R.id.id_poor_edit)).loadJson("/sdcard/pooredit/debug/");

}

 return super.onOptionsItemSelected(item);

  
}

When you click those menu items, a json file located in /sdcard/pooredit/debug/content.json will be created / loaded.

ImageLoader Interface

When adding images to PoorEdit, it may cause an OOM when images are too large or too many.

So, I secured a image loader interface to let you using your favorite image loaders to manage the loading & caching process.

You need to implement ImageLoaderItf and pass it to PoorEdit. Thus when PoorEdit need to decode or loading images, it will call this interface.

By default, PoorEdit will call ImageView.setImageBitmap directly without any loading or caching control.

 Image.ImageLoaderItf itf = new Image.ImageLoaderItf() {

@Override

public void loadImage(ImageView imageView, String image, int imageWidth) {

 //call your image loader here.

}

  
}
;

 poorEdit.setImageLoader(itf);

  //Do NOT use below code!
  //poorEdit.imageLoaderItf = itf;
  //I've noticed this is not a good design so it will be fixed soon!
  //setImageLoader method will remains and the static ImageLoaderItf field is not guaranteed!

Todos

  • UI tweaks.
  • Bug fix.
  • Add voices.
  • Add handwritings
  • Font & Colors

Why

To be honest I always thinking about writing a rich text editor on Android.

There are lots of brilliant projects on GitHub.

But still, I wondering whether I can do it or not.

So here we are.

I take Evernote's edit widget as a reference.

I didn't use webview in this widget.

All code are written in pure Java.

And I have to say to writing a complex widget like that is so hard for just one guy.

So,

ANY PULL REQUSTS IS WELCOME!

THANKS IN ADVANCE!

Credits

Icons from icons8.com

License

Good Boy License

Please do whatever your mom would approve of.

Resources

RevelyGradient is an Android library for easy gradient management!

A general-purpose logging library with built-in support to save logs to file.

Drawer behavior is a library that provide a extra behavior on drawer, such as, move view or scaling view's height while drawer on slide.

An awesome slidingmenu which has flexible elastic.

Interaction Cards are stylish cards that you can use on any of your activity or fragment to show these cards for many purposes.

It is inspired from Uber app and it can be used for various tasks in your app.

Let's assume you have notification to show your users, just put Interaction layouts and your users will see cards with beautiful ui.

You can dynamically change title, overlay color

NYBus - A pub-sub library for Android and Java applications.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes