MCPcopy
hub / github.com/Baseflow/PhotoView

github.com/Baseflow/PhotoView @2.3.0 sqlite

repository ↗ · DeepWiki ↗ · release 2.3.0 ↗
211 symbols 424 edges 25 files 30 documented · 14%
README

PhotoView

PhotoView aims to help produce an easily usable implementation of a zooming Android ImageView.

Dependency

Add this in your root build.gradle file (not your module build.gradle file):

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

Then, add the library to your module build.gradle

dependencies {
    implementation 'com.github.chrisbanes:PhotoView:latest.release.here'
}

Features

  • Out of the box zooming, using multi-touch and double-tap.
  • Scrolling, with smooth scrolling fling.
  • Works perfectly when used in a scrolling parent (such as ViewPager).
  • Allows the application to be notified when the displayed Matrix has changed. Useful for when you need to update your UI based on the current zoom/scroll position.
  • Allows the application to be notified when the user taps on the Photo.

Usage

There is a sample provided which shows how to use the library in a more advanced way, but for completeness, here is all that is required to get PhotoView working:

<com.github.chrisbanes.photoview.PhotoView
    android:id="@+id/photo_view"
    android:layout_width="match_parent"
    android:layout_height="match_parent"/>
PhotoView photoView = (PhotoView) findViewById(R.id.photo_view);
photoView.setImageResource(R.drawable.image);

That's it!

Issues With ViewGroups

There are some ViewGroups (ones that utilize onInterceptTouchEvent) that throw exceptions when a PhotoView is placed within them, most notably ViewPager and DrawerLayout. This is a framework issue that has not been resolved. In order to prevent this exception (which typically occurs when you zoom out), take a look at HackyDrawerLayout and you can see the solution is to simply catch the exception. Any ViewGroup which uses onInterceptTouchEvent will also need to be extended and exceptions caught. Use the HackyDrawerLayout as a template of how to do so. The basic implementation is:

public class HackyProblematicViewGroup extends ProblematicViewGroup {

    public HackyProblematicViewGroup(Context context) {
        super(context);
    }

    @Override
    public boolean onInterceptTouchEvent(MotionEvent ev) {
        try {
            return super.onInterceptTouchEvent(ev);
        } catch (IllegalArgumentException e) {
                        //uncomment if you really want to see these errors
            //e.printStackTrace();
            return false;
        }
    }
}

Usage with Fresco

Due to the complex nature of Fresco, this library does not currently support Fresco. See this project as an alternative solution.

Subsampling Support

This library aims to keep the zooming implementation simple. If you are looking for an implementation that supports subsampling, check out this project

License

Copyright 2018 Chris Banes

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.

Extension points exported contracts — how you extend this code

OnSingleFlingListener (Interface)
A callback to be invoked when the ImageView is flung with a single touch [3 implementers]
photoview/src/main/java/com/github/chrisbanes/photoview/OnSingleFlingListener.java
Listener (Interface)
(no doc) [1 implementers]
sample/src/main/java/com/github/chrisbanes/photoview/sample/ImageAdapter.java
OnPhotoTapListener (Interface)
A callback to be invoked when the Photo is tapped with a single tap. [3 implementers]
photoview/src/main/java/com/github/chrisbanes/photoview/OnPhotoTapListener.java
OnMatrixChangedListener (Interface)
Interface definition for a callback to be invoked when the internal Matrix has changed for this View. [2 implementers]
photoview/src/main/java/com/github/chrisbanes/photoview/OnMatrixChangedListener.java
OnViewDragListener (Interface)
Interface definition for a callback to be invoked when the photo is experiencing a drag event [1 implementers]
photoview/src/main/java/com/github/chrisbanes/photoview/OnViewDragListener.java
OnOutsidePhotoTapListener (Interface)
Callback when the user tapped outside of the photo
photoview/src/main/java/com/github/chrisbanes/photoview/OnOutsidePhotoTapListener.java

Core symbols most depended-on inside this repo

getScale
called by 9
photoview/src/main/java/com/github/chrisbanes/photoview/PhotoViewAttacher.java
setScaleType
called by 9
photoview/src/main/java/com/github/chrisbanes/photoview/PhotoView.java
checkAndDisplayMatrix
called by 8
photoview/src/main/java/com/github/chrisbanes/photoview/PhotoViewAttacher.java
update
called by 7
photoview/src/main/java/com/github/chrisbanes/photoview/PhotoViewAttacher.java
getDisplayRect
called by 6
photoview/src/main/java/com/github/chrisbanes/photoview/PhotoViewAttacher.java
getDrawMatrix
called by 5
photoview/src/main/java/com/github/chrisbanes/photoview/PhotoViewAttacher.java
isScaling
called by 4
photoview/src/main/java/com/github/chrisbanes/photoview/CustomGestureDetector.java
checkZoomLevels
called by 4
photoview/src/main/java/com/github/chrisbanes/photoview/Util.java

Shape

Method 177
Class 25
Interface 9

Languages

Java100%

Modules by API surface

photoview/src/main/java/com/github/chrisbanes/photoview/PhotoViewAttacher.java66 symbols
photoview/src/main/java/com/github/chrisbanes/photoview/PhotoView.java41 symbols
sample/src/main/java/com/github/chrisbanes/photoview/sample/SimpleSampleActivity.java11 symbols
sample/src/main/java/com/github/chrisbanes/photoview/sample/LauncherActivity.java11 symbols
photoview/src/main/java/com/github/chrisbanes/photoview/CustomGestureDetector.java11 symbols
sample/src/main/java/com/github/chrisbanes/photoview/sample/ImageAdapter.java8 symbols
sample/src/main/java/com/github/chrisbanes/photoview/sample/ViewPagerActivity.java7 symbols
sample/src/main/java/com/github/chrisbanes/photoview/sample/RotationSampleActivity.java7 symbols
sample/src/main/java/com/github/chrisbanes/photoview/sample/ImmersiveActivity.java5 symbols
photoview/src/main/java/com/github/chrisbanes/photoview/Util.java5 symbols
sample/src/main/java/com/github/chrisbanes/photoview/sample/ImageViewHolder.java4 symbols
sample/src/main/java/com/github/chrisbanes/photoview/sample/ActivityTransitionActivity.java4 symbols

For agents

$ claude mcp add PhotoView \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact