From 48d402567b89be7d8adcc166410ea1e25d2e6fff Mon Sep 17 00:00:00 2001 From: Kakit Ho Date: Sat, 27 Jan 2018 10:34:35 +0800 Subject: [PATCH] Add JavaDoc --- README.md | 11 +- .../main/java/me/echodev/resizer/Resizer.java | 67 +- docs/allclasses-frame.html | 19 + docs/allclasses-noframe.html | 19 + docs/constant-values.html | 120 ++++ docs/deprecated-list.html | 120 ++++ docs/help-doc.html | 217 +++++++ docs/index-files/index-1.html | 139 +++++ docs/index-files/index-2.html | 125 ++++ docs/index-files/index-3.html | 131 ++++ docs/index-files/index-4.html | 151 +++++ docs/index.html | 72 +++ docs/me/echodev/resizer/Resizer.html | 502 +++++++++++++++ docs/me/echodev/resizer/package-frame.html | 20 + docs/me/echodev/resizer/package-summary.html | 140 +++++ docs/me/echodev/resizer/package-tree.html | 129 ++++ docs/overview-tree.html | 133 ++++ docs/package-list | 1 + docs/script.js | 30 + docs/stylesheet.css | 574 ++++++++++++++++++ 20 files changed, 2711 insertions(+), 9 deletions(-) create mode 100644 docs/allclasses-frame.html create mode 100644 docs/allclasses-noframe.html create mode 100644 docs/constant-values.html create mode 100644 docs/deprecated-list.html create mode 100644 docs/help-doc.html create mode 100644 docs/index-files/index-1.html create mode 100644 docs/index-files/index-2.html create mode 100644 docs/index-files/index-3.html create mode 100644 docs/index-files/index-4.html create mode 100644 docs/index.html create mode 100644 docs/me/echodev/resizer/Resizer.html create mode 100644 docs/me/echodev/resizer/package-frame.html create mode 100644 docs/me/echodev/resizer/package-summary.html create mode 100644 docs/me/echodev/resizer/package-tree.html create mode 100644 docs/overview-tree.html create mode 100644 docs/package-list create mode 100644 docs/script.js create mode 100644 docs/stylesheet.css diff --git a/README.md b/README.md index 48aea76..63a193f 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ allprojects { 2. Add the dependency in your module-level build.gradle ```groovy dependencies { - compile 'com.github.hkk595:Resizer:v1.3' + compile 'com.github.hkk595:Resizer:v1.4' } ``` @@ -27,6 +27,7 @@ File resizedImage = new Resizer(this) .setTargetLength(1080) .setQuality(80) .setOutputFormat("JPEG") + .setOutputFilename("resized_image") .setOutputDirPath(storagePath) .setSourceImage(originalImage) .getResizedFile(); @@ -38,7 +39,7 @@ Bitmap resizedImage = new Resizer(this) .setSourceImage(originalImage) .getResizedBitmap(); ``` -Note: You only need to specify the target length (in pixel) of the longer side of the image. Resizer will calculate the rest automatically. +Note: You only need to specify the target length (in pixel) of the longer side (or either side if it's a square) of the image. Resizer will calculate the rest automatically. #### Using RxJava 2 with RxAndroid to get the resized image asynchronously ```java @@ -47,6 +48,7 @@ new Resizer(this) .setTargetLength(1080) .setQuality(80) .setOutputFormat("JPEG") + .setOutputFilename("resized_image") .setOutputDirPath(storagePath) .setSourceImage(originalImage) .getResizedFileAsFlowable() @@ -84,7 +86,9 @@ new Resizer(this) } }); ``` -Note: You don't need to declare the new image as final nor array if it is an instance variable of the class, instead of a local variable in a function. +Note: You don't need to declare the new image as final nor array if it's an instance variable of the class, instead of a local variable in a function. + +#### Refer to the [JavaDoc](https://hkk595.github.io/Resizer) for more details. #### Library specification Minimum SDK: API 16 @@ -93,6 +97,7 @@ Note: You don't need to declare the new image as final nor array if it is an ins targetLength: 1080 quality: 80 outputFormat: JPEG + outputFilename: same as the source file outputDirPath: the external files directory of your app Supported input formats: diff --git a/app/src/main/java/me/echodev/resizer/Resizer.java b/app/src/main/java/me/echodev/resizer/Resizer.java index fa4b414..9a4452a 100644 --- a/app/src/main/java/me/echodev/resizer/Resizer.java +++ b/app/src/main/java/me/echodev/resizer/Resizer.java @@ -16,13 +16,19 @@ * Created by K.K. Ho on 1/9/2017. */ +/** + * An image resizing library for Android, which allows you to scale an image file to a smaller or bigger one while keeping the aspect ratio. + */ public class Resizer { private int targetLength, quality; private Bitmap.CompressFormat compressFormat; - private String outputDirPath; - private String outputFilename; + private String outputDirPath, outputFilename; private File sourceImage; + /** + * The constructor to initialize Resizer instance. + * @param context The global application context. You can get it by getApplicationContext(). + */ public Resizer(Context context) { targetLength = 1080; quality = 80; @@ -31,16 +37,31 @@ public Resizer(Context context) { outputFilename = null; } + /** + * Set the target length of the image. You only need to specify the target length of the longer side (or either side if it's a square). Resizer will calculate the rest automatically. + * @param targetLength The target image length in pixel. The default value is 1080. + * @return This Resizer instance, for chained settings. + */ public Resizer setTargetLength(int targetLength) { this.targetLength = targetLength; return this; } + /** + * Set the image quality. The higher value, the better image quality but larger file size. PNG, which is a lossless format, will ignore the quality setting. + * @param quality The image quality value, ranges from 0 to 100. The default value is 80. + * @return This Resizer instance, for chained settings. + */ public Resizer setQuality(int quality) { this.quality = quality; return this; } + /** + * Set the image compression format by String. + * @param outputFormat The compression format. The default format is JPEG. + * @return This Resizer instance, for chained settings. + */ public Resizer setOutputFormat(String outputFormat) { switch (outputFormat) { case "JPEG": @@ -56,6 +77,11 @@ public Resizer setOutputFormat(String outputFormat) { return this; } + /** + * Set the image compression format by Bitmap.CompressFormat. + * @param compressFormat The compression format. The default format is JPEG. + * @return This Resizer instance, for chained settings. + */ public Resizer setOutputFormat(Bitmap.CompressFormat compressFormat) { if (compressFormat == null) { throw new NullPointerException("compressFormat null"); @@ -65,11 +91,12 @@ public Resizer setOutputFormat(Bitmap.CompressFormat compressFormat) { return this; } - /** Set output file name. - * @param filename name of the output file, without file extension - * */ + /** + * Set the output file name. If you don't set it, the output file will have the same name as the source file. + * @param filename The name of the output file, without file extension. + * @return This Resizer instance, for chained settings. + */ public Resizer setOutputFilename(String filename) { - if (filename == null) { throw new NullPointerException("filename null"); } @@ -85,25 +112,49 @@ public Resizer setOutputFilename(String filename) { return this; } + /** + * Set the output directory path. If this is the same as where the source image locates, the source image can be overwritten. + * @param outputDirPath The path of the output directory. The default path is the external files directory of your app + * @return This Resizer instance, for chained settings. + */ public Resizer setOutputDirPath(String outputDirPath) { this.outputDirPath = outputDirPath; return this; } + /** + * Set the source image file. + * @param sourceImage The source image file to be resized. + * @return This Resizer instance, for chained settings. + */ public Resizer setSourceImage(File sourceImage) { this.sourceImage = sourceImage; return this; } + /** + * Get the resized image file. + * @return The resized image file. + * @throws IOException + */ public File getResizedFile() throws IOException { return ImageUtils.getScaledImage(targetLength, quality, compressFormat, outputDirPath, outputFilename, sourceImage); } + /** + * Get the resized image bitmap. + * @return The resized image bitmap. + * @throws IOException + */ public Bitmap getResizedBitmap() throws IOException { return ImageUtils.getScaledBitmap(targetLength, sourceImage); } + /** + * Get the resized image file as RxJava Flowable. + * @return A Flowable that emits the resized image file or error. + */ public Flowable getResizedFileAsFlowable() { return Flowable.defer(new Callable>() { @Override @@ -117,6 +168,10 @@ public Flowable call() { }); } + /** + * Get the resized image bitmap as RxJava Flowable. + * @return A Flowable that emits the resized image bitmap or error. + */ public Flowable getResizedBitmapAsFlowable() { return Flowable.defer(new Callable>() { @Override diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html new file mode 100644 index 0000000..1e277f9 --- /dev/null +++ b/docs/allclasses-frame.html @@ -0,0 +1,19 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html new file mode 100644 index 0000000..36f902e --- /dev/null +++ b/docs/allclasses-noframe.html @@ -0,0 +1,19 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/docs/constant-values.html b/docs/constant-values.html new file mode 100644 index 0000000..5c19f8f --- /dev/null +++ b/docs/constant-values.html @@ -0,0 +1,120 @@ + + + + + +Constant Field Values + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html new file mode 100644 index 0000000..6f039e7 --- /dev/null +++ b/docs/deprecated-list.html @@ -0,0 +1,120 @@ + + + + + +Deprecated List + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/docs/help-doc.html b/docs/help-doc.html new file mode 100644 index 0000000..96f866e --- /dev/null +++ b/docs/help-doc.html @@ -0,0 +1,217 @@ + + + + + +API Help + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html new file mode 100644 index 0000000..e250224 --- /dev/null +++ b/docs/index-files/index-1.html @@ -0,0 +1,139 @@ + + + + + +G-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
G M R S  + + +

G

+
+
getResizedBitmap() - Method in class me.echodev.resizer.Resizer
+
+
Get the resized image bitmap.
+
+
getResizedBitmapAsFlowable() - Method in class me.echodev.resizer.Resizer
+
+
Get the resized image bitmap as RxJava Flowable.
+
+
getResizedFile() - Method in class me.echodev.resizer.Resizer
+
+
Get the resized image file.
+
+
getResizedFileAsFlowable() - Method in class me.echodev.resizer.Resizer
+
+
Get the resized image file as RxJava Flowable.
+
+
+G M R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html new file mode 100644 index 0000000..2c2a45b --- /dev/null +++ b/docs/index-files/index-2.html @@ -0,0 +1,125 @@ + + + + + +M-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
G M R S  + + +

M

+
+
me.echodev.resizer - package me.echodev.resizer
+
 
+
+G M R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html new file mode 100644 index 0000000..6759930 --- /dev/null +++ b/docs/index-files/index-3.html @@ -0,0 +1,131 @@ + + + + + +R-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
G M R S  + + +

R

+
+
Resizer - Class in me.echodev.resizer
+
+
An image resizing library for Android, which allows you to scale an image file to a smaller or bigger one while keeping the aspect ratio.
+
+
Resizer(Context) - Constructor for class me.echodev.resizer.Resizer
+
+
The constructor to initialize Resizer instance.
+
+
+G M R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html new file mode 100644 index 0000000..72e2072 --- /dev/null +++ b/docs/index-files/index-4.html @@ -0,0 +1,151 @@ + + + + + +S-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
G M R S  + + +

S

+
+
setOutputDirPath(String) - Method in class me.echodev.resizer.Resizer
+
+
Set the output directory path.
+
+
setOutputFilename(String) - Method in class me.echodev.resizer.Resizer
+
+
Set the output file name.
+
+
setOutputFormat(String) - Method in class me.echodev.resizer.Resizer
+
+
Set the image compression format by String.
+
+
setOutputFormat(Bitmap.CompressFormat) - Method in class me.echodev.resizer.Resizer
+
+
Set the image compression format by Bitmap.CompressFormat.
+
+
setQuality(int) - Method in class me.echodev.resizer.Resizer
+
+
Set the image quality.
+
+
setSourceImage(File) - Method in class me.echodev.resizer.Resizer
+
+
Set the source image file.
+
+
setTargetLength(int) - Method in class me.echodev.resizer.Resizer
+
+
Set the target length of the image.
+
+
+G M R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..f8d4490 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,72 @@ + + + + + +Generated Documentation (Untitled) + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="me/echodev/resizer/package-summary.html">Non-frame version</a>.</p> + + + diff --git a/docs/me/echodev/resizer/Resizer.html b/docs/me/echodev/resizer/Resizer.html new file mode 100644 index 0000000..ff89bf8 --- /dev/null +++ b/docs/me/echodev/resizer/Resizer.html @@ -0,0 +1,502 @@ + + + + + +Resizer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
me.echodev.resizer
+

Class Resizer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • me.echodev.resizer.Resizer
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class Resizer
+extends java.lang.Object
    +
    An image resizing library for Android, which allows you to scale an image file to a smaller or bigger one while keeping the aspect ratio.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Resizer(android.content.Context context) +
      The constructor to initialize Resizer instance.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      android.graphics.BitmapgetResizedBitmap() +
      Get the resized image bitmap.
      +
      io.reactivex.Flowable<android.graphics.Bitmap>getResizedBitmapAsFlowable() +
      Get the resized image bitmap as RxJava Flowable.
      +
      java.io.FilegetResizedFile() +
      Get the resized image file.
      +
      io.reactivex.Flowable<java.io.File>getResizedFileAsFlowable() +
      Get the resized image file as RxJava Flowable.
      +
      ResizersetOutputDirPath(java.lang.String outputDirPath) +
      Set the output directory path.
      +
      ResizersetOutputFilename(java.lang.String filename) +
      Set the output file name.
      +
      ResizersetOutputFormat(android.graphics.Bitmap.CompressFormat compressFormat) +
      Set the image compression format by Bitmap.CompressFormat.
      +
      ResizersetOutputFormat(java.lang.String outputFormat) +
      Set the image compression format by String.
      +
      ResizersetQuality(int quality) +
      Set the image quality.
      +
      ResizersetSourceImage(java.io.File sourceImage) +
      Set the source image file.
      +
      ResizersetTargetLength(int targetLength) +
      Set the target length of the image.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Resizer

        +
        public Resizer(android.content.Context context)
        +
        The constructor to initialize Resizer instance.
        +
        +
        Parameters:
        +
        context - The global application context. You can get it by getApplicationContext().
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setTargetLength

        +
        public Resizer setTargetLength(int targetLength)
        +
        Set the target length of the image. You only need to specify the target length of the longer side (or either side if it's a square). Resizer will calculate the rest automatically.
        +
        +
        Parameters:
        +
        targetLength - The target image length in pixel. The default value is 1080.
        +
        Returns:
        +
        This Resizer instance, for chained settings.
        +
        +
        • +
      + + + +
        +
      • +

        setQuality

        +
        public Resizer setQuality(int quality)
        +
        Set the image quality. The higher value, the better image quality but larger file size. PNG, which is a lossless format, will ignore the quality setting.
        +
        +
        Parameters:
        +
        quality - The image quality value, ranges from 0 to 100. The default value is 80.
        +
        Returns:
        +
        This Resizer instance, for chained settings.
        +
        +
        • +
      + + + +
        +
      • +

        setOutputFormat

        +
        public Resizer setOutputFormat(java.lang.String outputFormat)
        +
        Set the image compression format by String.
        +
        +
        Parameters:
        +
        outputFormat - The compression format. The default format is JPEG.
        +
        Returns:
        +
        This Resizer instance, for chained settings.
        +
        +
        • +
      + + + +
        +
      • +

        setOutputFormat

        +
        public Resizer setOutputFormat(android.graphics.Bitmap.CompressFormat compressFormat)
        +
        Set the image compression format by Bitmap.CompressFormat.
        +
        +
        Parameters:
        +
        compressFormat - The compression format. The default format is JPEG.
        +
        Returns:
        +
        This Resizer instance, for chained settings.
        +
        +
        • +
      + + + +
        +
      • +

        setOutputFilename

        +
        public Resizer setOutputFilename(java.lang.String filename)
        +
        Set the output file name. If you don't set it, the output file will have the same name as the source file.
        +
        +
        Parameters:
        +
        filename - The name of the output file, without file extension.
        +
        Returns:
        +
        This Resizer instance, for chained settings.
        +
        +
        • +
      + + + +
        +
      • +

        setOutputDirPath

        +
        public Resizer setOutputDirPath(java.lang.String outputDirPath)
        +
        Set the output directory path. If this is the same as where the source image locates, the source image can be overwritten.
        +
        +
        Parameters:
        +
        outputDirPath - The path of the output directory. The default path is the external files directory of your app
        +
        Returns:
        +
        This Resizer instance, for chained settings.
        +
        +
        • +
      + + + +
        +
      • +

        setSourceImage

        +
        public Resizer setSourceImage(java.io.File sourceImage)
        +
        Set the source image file.
        +
        +
        Parameters:
        +
        sourceImage - The source image file to be resized.
        +
        Returns:
        +
        This Resizer instance, for chained settings.
        +
        +
        • +
      + + + +
        +
      • +

        getResizedFile

        +
        public java.io.File getResizedFile()
+                            throws java.io.IOException
        +
        Get the resized image file.
        +
        +
        Returns:
        +
        The resized image file.
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        getResizedBitmap

        +
        public android.graphics.Bitmap getResizedBitmap()
+                                         throws java.io.IOException
        +
        Get the resized image bitmap.
        +
        +
        Returns:
        +
        The resized image bitmap.
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        getResizedFileAsFlowable

        +
        public io.reactivex.Flowable<java.io.File> getResizedFileAsFlowable()
        +
        Get the resized image file as RxJava Flowable.
        +
        +
        Returns:
        +
        A Flowable that emits the resized image file or error.
        +
        +
        • +
      + + + +
        +
      • +

        getResizedBitmapAsFlowable

        +
        public io.reactivex.Flowable<android.graphics.Bitmap> getResizedBitmapAsFlowable()
        +
        Get the resized image bitmap as RxJava Flowable.
        +
        +
        Returns:
        +
        A Flowable that emits the resized image bitmap or error.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/me/echodev/resizer/package-frame.html b/docs/me/echodev/resizer/package-frame.html new file mode 100644 index 0000000..30393d0 --- /dev/null +++ b/docs/me/echodev/resizer/package-frame.html @@ -0,0 +1,20 @@ + + + + + +me.echodev.resizer + + + + + +

me.echodev.resizer

+
+

Classes

+ +
+ + diff --git a/docs/me/echodev/resizer/package-summary.html b/docs/me/echodev/resizer/package-summary.html new file mode 100644 index 0000000..3c5bda8 --- /dev/null +++ b/docs/me/echodev/resizer/package-summary.html @@ -0,0 +1,140 @@ + + + + + +me.echodev.resizer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ +
+

Package me.echodev.resizer

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Resizer +
    An image resizing library for Android, which allows you to scale an image file to a smaller or bigger one while keeping the aspect ratio.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Package
    • +
  • Next Package
    • +
+ + +
+ +
+ + +
+ + + diff --git a/docs/me/echodev/resizer/package-tree.html b/docs/me/echodev/resizer/package-tree.html new file mode 100644 index 0000000..fc757be --- /dev/null +++ b/docs/me/echodev/resizer/package-tree.html @@ -0,0 +1,129 @@ + + + + + +me.echodev.resizer Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For Package me.echodev.resizer

+
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/docs/overview-tree.html b/docs/overview-tree.html new file mode 100644 index 0000000..663c8e3 --- /dev/null +++ b/docs/overview-tree.html @@ -0,0 +1,133 @@ + + + + + +Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/docs/package-list b/docs/package-list new file mode 100644 index 0000000..af23d31 --- /dev/null +++ b/docs/package-list @@ -0,0 +1 @@ +me.echodev.resizer diff --git a/docs/script.js b/docs/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/docs/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/stylesheet.css b/docs/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/docs/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +}