Skip to content
This repository has been archived by the owner on Dec 3, 2023. It is now read-only.

Latest commit

 

History

History
181 lines (131 loc) · 7.11 KB

README.md

File metadata and controls

181 lines (131 loc) · 7.11 KB
Raw

##HighlightJs View - Android A syntax highlighting view, powered by highlight.js, for Android.

Maven Central

##Demo Application

The demo application shows a simple example usage for this library. It lists the files of this repository's commits and allows you to browse the changed files. Selecting a file show's up the syntax highlighted content.

Note: In case the sample application doesn't load the content you can fork this repo and replace the anonymous Github-Login with your credentials (This bug is caused by the Github Library used in the sample app)

###Screenshot

###Download

You can download the sample apk here

##Getting Started

###Add the library as dependency

Add the library as dependency to your build.gradle file.

dependencies {
	//other dependencies...
	compile 'com.pddstudio:highlightjs-android:X.X.X'
}

Replace X.X.X with the current version - which can be found in the release section

###Include the View into your Layout

Add the View to your existing layout file.

<RelativeLayout 
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <!-- Other views here -->

    <com.pddstudio.highlightjs.HighlightJsView
	android:id="@+id/highlight_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />

    <!-- Other views here -->

</RelativeLayout>

###Assign the view and set it's content

In your Activity/Fragment assign the view and set it's content.

@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_syntax);
        //other stuff here ....

        //find and instantiate the view
        highlightJsView = (HighlightJsView) findViewById(R.id.highlight_view);

		//optional: register callbacks and style the view

        //register theme change listener
        highlightJsView.setOnThemeChangedListener(this);
        //change theme and set language to auto detect
        highlightJsView.setTheme(Theme.ANDROID_STUDIO);
        highlightJsView.setHighlightLanguage(Language.AUTO_DETECT);
        //load the source (can be loaded by String, File or URL)
        highlightJsView.setSource(fileObject.getUrl());
    }

###Customize the View

For a complete overview of all themes and languages you can check out the official highlight.js demo here

You can customize the View's Theme and Language. By default the Theme is set to Theme.DEFAULT and the language is set to Language.AUTO_DETECT

Change the view's theme:

//change theme
highlightJsView.setTheme(Theme.ANDROID_STUDIO);

The library supports all themes that are included in highlight.js version 9.4.0

Browse the list of themes here

Change the view's language:

//change language
highlightJsView.setHighlightLanguage(Language.JAVA);

The library supports all languages that are included in highlight.js version 9.4.0 (more than +130 languages)

Browse the list of languages here

###Change the view's source

You can load the source you want to be highlighted by either a String containing the actual source code, a File object which represents the file containing the source code or an URL object to load the source code from a remote Url.

try {
	markdownUrl = new URL("https://raw.githubusercontent.com/PDDStudio/highlightjs-android/master/README.md");
} catch (Exception e) {
	e.printStackTrace();
}
//change the displayed source
highlightJsView.setSource(markdownUrl);
//make sure to call reload() when changing content during runtime
highlightJsView.reload();

Notes:

  • Source Code which is loaded via URL requires internet permission (source is loaded asynchronous) <uses-permission android:name="android.permission.INTERNET" />
  • Source Code which is loaded by a File object from the device's internal storage requires storage permission (especially on +Android 6.0)

##About & Contact

##License

    Copyright 2016 Patrick J

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

	Copyright (c) 2006, Ivan Sagalaev
	All rights reserved.
	Redistribution and use in source and binary forms, with or without
	modification, are permitted provided that the following conditions are met:

	    * Redistributions of source code must retain the above copyright
	      notice, this list of conditions and the following disclaimer.
	    * Redistributions in binary form must reproduce the above copyright
	      notice, this list of conditions and the following disclaimer in the
	      documentation and/or other materials provided with the distribution.
	    * Neither the name of highlight.js nor the names of its contributors 
	      may be used to endorse or promote products derived from this software 
	      without specific prior written permission.

	THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
	EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
	DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
	(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.