144 lines
38 KiB
HTML
144 lines
38 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en-US">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>Images | Markwon</title>
|
|
<meta name="description" content="Android markdown library based on commonmark specification that renders markdown as system-native Spannables (no WebView)">
|
|
<link rel="apple-touch-icon" sizes="180x180" href="/Markwon/apple-touch-icon.png?v=1">
|
|
<link rel="icon" type="image/png" sizes="16x16" href="/Markwon/favicon-16x16.png?v=1">
|
|
<link rel="icon" href="/Markwon/favicon.ico?v=1">
|
|
<link rel="icon" type="image/png" sizes="32x32" href="/Markwon/favicon-32x32.png?v=1">
|
|
<link rel="manifest" href="/Markwon/manifest.json?v=1">
|
|
<meta name="keywords" content="android,markdown,library,spannable,markwon,commonmark">
|
|
|
|
<link rel="preload" href="/Markwon/assets/css/0.styles.3fbbce9e.css" as="style"><link rel="preload" href="/Markwon/assets/js/app.bdfd2bc6.js" as="script"><link rel="preload" href="/Markwon/assets/js/35.1684da38.js" as="script"><link rel="preload" href="/Markwon/assets/js/3.eaac0903.js" as="script"><link rel="preload" href="/Markwon/assets/js/12.98308542.js" as="script"><link rel="prefetch" href="/Markwon/assets/js/42.d7ca0851.js"><link rel="prefetch" href="/Markwon/assets/js/2.81714ae9.js"><link rel="prefetch" href="/Markwon/assets/js/4.31fa5321.js"><link rel="prefetch" href="/Markwon/assets/js/5.6234b6a3.js"><link rel="prefetch" href="/Markwon/assets/js/6.ef59e46d.js"><link rel="prefetch" href="/Markwon/assets/js/7.e9b37c71.js"><link rel="prefetch" href="/Markwon/assets/js/8.9dff76ac.js"><link rel="prefetch" href="/Markwon/assets/js/9.7d018a47.js"><link rel="prefetch" href="/Markwon/assets/js/10.99fc608c.js"><link rel="prefetch" href="/Markwon/assets/js/11.cdc173e9.js"><link rel="prefetch" href="/Markwon/assets/js/13.83b81b01.js"><link rel="prefetch" href="/Markwon/assets/js/14.0e5fe31e.js"><link rel="prefetch" href="/Markwon/assets/js/15.724f3dc4.js"><link rel="prefetch" href="/Markwon/assets/js/16.076204be.js"><link rel="prefetch" href="/Markwon/assets/js/17.9412daf3.js"><link rel="prefetch" href="/Markwon/assets/js/18.187f0167.js"><link rel="prefetch" href="/Markwon/assets/js/19.af3507a7.js"><link rel="prefetch" href="/Markwon/assets/js/20.dc11e22f.js"><link rel="prefetch" href="/Markwon/assets/js/21.393a507f.js"><link rel="prefetch" href="/Markwon/assets/js/22.a6ac92c5.js"><link rel="prefetch" href="/Markwon/assets/js/23.9edcc0b3.js"><link rel="prefetch" href="/Markwon/assets/js/24.073942b3.js"><link rel="prefetch" href="/Markwon/assets/js/25.507307eb.js"><link rel="prefetch" href="/Markwon/assets/js/26.87c7e366.js"><link rel="prefetch" href="/Markwon/assets/js/27.a6f7a96f.js"><link rel="prefetch" href="/Markwon/assets/js/28.c0caacb4.js"><link rel="prefetch" href="/Markwon/assets/js/29.230c7321.js"><link rel="prefetch" href="/Markwon/assets/js/30.45e92827.js"><link rel="prefetch" href="/Markwon/assets/js/31.3a2ff699.js"><link rel="prefetch" href="/Markwon/assets/js/32.662e2ab9.js"><link rel="prefetch" href="/Markwon/assets/js/33.d83b2cb7.js"><link rel="prefetch" href="/Markwon/assets/js/34.4b19ef85.js"><link rel="prefetch" href="/Markwon/assets/js/36.9852715d.js"><link rel="prefetch" href="/Markwon/assets/js/37.e98b3352.js"><link rel="prefetch" href="/Markwon/assets/js/38.09771599.js"><link rel="prefetch" href="/Markwon/assets/js/39.37003a65.js"><link rel="prefetch" href="/Markwon/assets/js/40.bf595a01.js"><link rel="prefetch" href="/Markwon/assets/js/41.db50f781.js"><link rel="prefetch" href="/Markwon/assets/js/43.78500964.js"><link rel="prefetch" href="/Markwon/assets/js/44.60fec7f9.js"><link rel="prefetch" href="/Markwon/assets/js/45.78224b99.js"><link rel="prefetch" href="/Markwon/assets/js/46.9a7f306b.js"><link rel="prefetch" href="/Markwon/assets/js/47.42b56911.js"><link rel="prefetch" href="/Markwon/assets/js/48.cceb75d4.js"><link rel="prefetch" href="/Markwon/assets/js/49.20507df8.js"><link rel="prefetch" href="/Markwon/assets/js/50.f89d88b1.js"><link rel="prefetch" href="/Markwon/assets/js/51.d7ac54ce.js"><link rel="prefetch" href="/Markwon/assets/js/52.394ded4e.js"><link rel="prefetch" href="/Markwon/assets/js/53.144cf408.js"><link rel="prefetch" href="/Markwon/assets/js/54.0f936c4f.js"><link rel="prefetch" href="/Markwon/assets/js/55.5b7382a9.js"><link rel="prefetch" href="/Markwon/assets/js/56.1cf2f788.js"><link rel="prefetch" href="/Markwon/assets/js/57.1b7dddc1.js"><link rel="prefetch" href="/Markwon/assets/js/58.5271aaaf.js"><link rel="prefetch" href="/Markwon/assets/js/59.7ef6ac9a.js"><link rel="prefetch" href="/Markwon/assets/js/60.9bbfa80f.js"><link rel="prefetch" href="/Markwon/assets/js/61.628c1500.js"><link rel="prefetch" href="/Markwon/assets/js/62.d4d206d7.js"><link rel="prefetch" href="/Markwon/assets/js/63.8ccf8bfc.js"><link rel="prefetch" href="/Markwon/assets/js/64.7672a52b.js"><link rel="prefetch" href="/Markwon/assets/js/65.c4f000dc.js"><link rel="prefetch" href="/Markwon/assets/js/66.4a29728a.js"><link rel="prefetch" href="/Markwon/assets/js/67.7331c7c7.js"><link rel="prefetch" href="/Markwon/assets/js/68.9d1d2ae1.js"><link rel="prefetch" href="/Markwon/assets/js/69.fd31295a.js"><link rel="prefetch" href="/Markwon/assets/js/70.fac8f892.js"><link rel="prefetch" href="/Markwon/assets/js/71.c3fcfb65.js"><link rel="prefetch" href="/Markwon/assets/js/72.d2389fc9.js"><link rel="prefetch" href="/Markwon/assets/js/73.6ce21170.js"><link rel="prefetch" href="/Markwon/assets/js/74.2ad91074.js"><link rel="prefetch" href="/Markwon/assets/js/75.1d59d27c.js"><link rel="prefetch" href="/Markwon/assets/js/76.f3844391.js"><link rel="prefetch" href="/Markwon/assets/js/77.4e5a82c3.js"><link rel="prefetch" href="/Markwon/assets/js/78.ff7203ee.js"><link rel="prefetch" href="/Markwon/assets/js/79.b1718a0d.js"><link rel="prefetch" href="/Markwon/assets/js/80.802db0eb.js"><link rel="prefetch" href="/Markwon/assets/js/81.9edd3cd9.js"><link rel="prefetch" href="/Markwon/assets/js/82.52f04a34.js"><link rel="prefetch" href="/Markwon/assets/js/83.3bd397c0.js"><link rel="prefetch" href="/Markwon/assets/js/84.a9af8a34.js"><link rel="prefetch" href="/Markwon/assets/js/85.2a0d8d40.js">
|
|
<link rel="stylesheet" href="/Markwon/assets/css/0.styles.3fbbce9e.css">
|
|
</head>
|
|
<body>
|
|
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/Markwon/" class="home-link router-link-active"><!----> <span class="site-name">Markwon</span></a> <div class="links" style="max-width:nullpx;"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/Markwon/docs/v4/install.html" class="nav-link">Install</a></div><div class="nav-item"><div class="dropdown-wrapper"><a class="dropdown-title"><span class="title">API Version</span> <span class="arrow right"></span></a> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><h4>Latest</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="/Markwon/" class="nav-link">4.x.x</a></li></ul></li><li class="dropdown-item"><h4>Legacy</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="/Markwon/docs/v3/install.html" class="nav-link">3.x.x</a></li><li class="dropdown-subitem"><a href="/Markwon/docs/v2/" class="nav-link">2.x.x</a></li></ul></li></ul></div></div><div class="nav-item"><a href="https://github.com/noties/Markwon/blob/master/CHANGELOG.md" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Changelog
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div><div class="nav-item"><a href="https://github.com/noties/Markwon" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Github
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <div class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/Markwon/docs/v4/install.html" class="nav-link">Install</a></div><div class="nav-item"><div class="dropdown-wrapper"><a class="dropdown-title"><span class="title">API Version</span> <span class="arrow right"></span></a> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><h4>Latest</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="/Markwon/" class="nav-link">4.x.x</a></li></ul></li><li class="dropdown-item"><h4>Legacy</h4> <ul class="dropdown-subitem-wrapper"><li class="dropdown-subitem"><a href="/Markwon/docs/v3/install.html" class="nav-link">3.x.x</a></li><li class="dropdown-subitem"><a href="/Markwon/docs/v2/" class="nav-link">2.x.x</a></li></ul></li></ul></div></div><div class="nav-item"><a href="https://github.com/noties/Markwon/blob/master/CHANGELOG.md" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Changelog
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div><div class="nav-item"><a href="https://github.com/noties/Markwon" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Github
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav> <ul class="sidebar-links"><li><a href="/Markwon/docs/v3/install.html" class="sidebar-link">/docs/v3/install.html</a></li><li><div class="sidebar-group"><p class="sidebar-heading open"><span>Core</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/Markwon/docs/v3/core/getting-started.html" class="sidebar-link">Getting started</a></li><li><a href="/Markwon/docs/v3/core/plugins.html" class="sidebar-link">Plugins</a></li><li><a href="/Markwon/docs/v3/core/theme.html" class="sidebar-link">Theme</a></li><li><a href="/Markwon/docs/v3/core/images.html" class="active sidebar-link">Images</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/Markwon/docs/v3/core/images.html#imagesplugin" class="sidebar-link">ImagesPlugin</a></li><li class="sidebar-sub-header"><a href="/Markwon/docs/v3/core/images.html#schemehandler" class="sidebar-link">SchemeHandler</a></li><li class="sidebar-sub-header"><a href="/Markwon/docs/v3/core/images.html#mediadecoder" class="sidebar-link">MediaDecoder</a></li><li class="sidebar-sub-header"><a href="/Markwon/docs/v3/core/images.html#placeholder-drawable" class="sidebar-link">Placeholder drawable</a></li><li class="sidebar-sub-header"><a href="/Markwon/docs/v3/core/images.html#error-drawable" class="sidebar-link">Error drawable</a></li></ul></li><li><a href="/Markwon/docs/v3/core/configuration.html" class="sidebar-link">Configuration</a></li><li><a href="/Markwon/docs/v3/core/visitor.html" class="sidebar-link">Visitor</a></li><li><a href="/Markwon/docs/v3/core/spans-factory.html" class="sidebar-link">Spans Factory</a></li><li><a href="/Markwon/docs/v3/core/html-renderer.html" class="sidebar-link">HTML Renderer</a></li><li><a href="/Markwon/docs/v3/core/core-plugin.html" class="sidebar-link">Core plugin</a></li><li><a href="/Markwon/docs/v3/core/movement-method-plugin.html" class="sidebar-link">Movement method plugin</a></li><li><a href="/Markwon/docs/v3/core/render-props.html" class="sidebar-link">RenderProps</a></li></ul></div></li><li><a href="/Markwon/docs/v3/ext-latex/" class="sidebar-link">LaTeX extension</a></li><li><a href="/Markwon/docs/v3/ext-strikethrough/" class="sidebar-link">Strikethrough extension</a></li><li><a href="/Markwon/docs/v3/ext-tables/" class="sidebar-link">Tables extension</a></li><li><a href="/Markwon/docs/v3/ext-tasklist/" class="sidebar-link">Task list extension</a></li><li><a href="/Markwon/docs/v3/html/" class="sidebar-link">HTML</a></li><li><a href="/Markwon/docs/v3/image/gif.html" class="sidebar-link">Image GIF</a></li><li><a href="/Markwon/docs/v3/image/okhttp.html" class="sidebar-link">Image OkHttp</a></li><li><a href="/Markwon/docs/v3/image/svg.html" class="sidebar-link">Image SVG</a></li><li><a href="/Markwon/docs/v3/recycler/" class="sidebar-link">Recycler</a></li><li><a href="/Markwon/docs/v3/recycler-table/" class="sidebar-link">Recycler Table</a></li><li><a href="/Markwon/docs/v3/syntax-highlight/" class="sidebar-link">Syntax highlight</a></li><li><a href="/Markwon/docs/v3/migration-2-3.html" class="sidebar-link">Migration 2.x.x -> 3.x.x</a></li></ul> </div> <div class="page"> <div class="content"><h1 id="images"><a href="#images" aria-hidden="true" class="header-anchor">#</a> Images</h1> <div class="warning custom-block"><p class="custom-block-title">WARNING</p> <p>This is documentation for <u>legacy</u> versions. For the most current version <a href="/Markwon/">click here.</a></p></div> <p>Starting with <span class="badge tip top" data-v-099ab69c>3.0.0</span> <code>Markwon</code> comes with <code>ImagesPlugin</code>
|
|
which supports <code>http(s)</code>, <code>file</code> and <code>data</code> schemes and default media
|
|
decoder (for simple images, no <a href="/Markwon/docs/v3/image/svg.html">SVG</a> or <a href="/Markwon/docs/v3/image/gif.html">GIF</a> which
|
|
are defined in standalone modules).</p> <h2 id="imagesplugin"><a href="#imagesplugin" aria-hidden="true" class="header-anchor">#</a> ImagesPlugin</h2> <p><code>ImagePlugin</code> takes care of <em>obtaining</em> image resource, decoding it and displaying it in a <code>TextView</code>.</p> <div class="warning custom-block"><p class="custom-block-title">WARNING</p> <p>Although <code>core</code> artifact contains <code>ImagesPlugin</code> one must
|
|
still <strong>explicitly</strong> register the <code>ImagesPlugin</code> on resulting <code>Markwon</code>
|
|
instance.</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">final</span> Markwon markwon <span class="token operator">=</span> Markwon<span class="token punctuation">.</span><span class="token function">builder</span><span class="token punctuation">(</span>context<span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">usePlugin</span><span class="token punctuation">(</span>ImagesPlugin<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
|
|
</code></pre></div></div> <p>There are 2 factory methods to obtain <code>ImagesPlugin</code>:</p> <ul><li><code>ImagesPlugin#create(Context)</code></li> <li><code>ImagesPlugin#createWithAssets(Context)</code></li></ul> <p>The first one <code>#create(Context)</code> configures:</p> <ul><li><code>FileSchemeHandler</code> that allows obtaining images from <code>file://</code> uris</li> <li><code>DataUriSchemeHandler</code> that allows <em>inlining</em> images with <code>data:</code>
|
|
scheme (<code>data:image/svg+xml;base64,MTIz</code>)</li> <li><code>NetworkSchemeHandler</code> that allows obtaining images from <code>http://</code> and <code>https://</code> uris
|
|
(internally it uses <code>HttpURLConnection</code>)</li> <li><code>ImageMediaDecoder</code> which <em>tries</em> to decode all encountered images as regular ones (png, jpg, etc)</li></ul> <p>The second one <code>#createWithAssets(Context)</code> does the same but also adds support
|
|
for images that reside in <code>assets</code> folder of your application and
|
|
referenced by <code>file:///android_asset/{path}</code> uri.</p> <p><code>ImagesPlugin</code> also <em>prepares</em> a TextView to display images. Due to asynchronous
|
|
nature of image loading, there must be a way to invalidate resulting Spanned
|
|
content after an image is loaded.</p> <div class="warning custom-block"><p class="custom-block-title">WARNING</p> <p>Images come with few limitations. For of all, they work with a <strong>TextView only</strong>.
|
|
This is due to the fact that there is no way to invalidate a <code>Spanned</code> content
|
|
by itself (without context in which it is displayed). So, if <code>Markwon</code> is used,
|
|
for example, to display a <code>Toast</code> with an image:</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">final</span> Spanned spanned <span class="token operator">=</span> markwon<span class="token punctuation">.</span><span class="token function">toMarkdown</span><span class="token punctuation">(</span><span class="token string">"Hello "</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
Toast<span class="token punctuation">.</span><span class="token function">makeText</span><span class="token punctuation">(</span>context<span class="token punctuation">,</span> spanned<span class="token punctuation">,</span> Toast<span class="token punctuation">.</span>LENGTH_LONG<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">show</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
</code></pre></div><p>Image <em>probably</em> won't be displayed. As a workaround for <code>Toast</code> a custom <code>View</code>
|
|
can be used:</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">final</span> Spanned spanned <span class="token operator">=</span> markwon<span class="token punctuation">.</span><span class="token function">toMarkdown</span><span class="token punctuation">(</span><span class="token string">"Hello "</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
|
|
<span class="token keyword">final</span> View view <span class="token operator">=</span> <span class="token function">createToastView</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token keyword">final</span> TextView textView <span class="token operator">=</span> view<span class="token punctuation">.</span><span class="token function">findViewById</span><span class="token punctuation">(</span>R<span class="token punctuation">.</span>id<span class="token punctuation">.</span>text_view<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
markwon<span class="token punctuation">.</span><span class="token function">setParsedMarkdown</span><span class="token punctuation">(</span>textView<span class="token punctuation">,</span> spanned<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
|
|
<span class="token keyword">final</span> Toast toast <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Toast</span><span class="token punctuation">(</span>context<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
toast<span class="token punctuation">.</span><span class="token function">setView</span><span class="token punctuation">(</span>view<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token comment">// other Toast configurations</span>
|
|
toast<span class="token punctuation">.</span><span class="token function">show</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
</code></pre></div></div> <h2 id="schemehandler"><a href="#schemehandler" aria-hidden="true" class="header-anchor">#</a> SchemeHandler</h2> <p>To add support for different schemes (or customize provided) a <code>SchemeHandler</code> must be used.</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">final</span> Markwon markwon <span class="token operator">=</span> Markwon<span class="token punctuation">.</span><span class="token function">builder</span><span class="token punctuation">(</span>context<span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">usePlugin</span><span class="token punctuation">(</span>ImagesPlugin<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span>context<span class="token punctuation">)</span><span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">usePlugin</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">AbstractMarkwonPlugin</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token annotation punctuation">@Override</span>
|
|
<span class="token keyword">public</span> <span class="token keyword">void</span> <span class="token function">configureImages</span><span class="token punctuation">(</span><span class="token annotation punctuation">@NonNull</span> AsyncDrawableLoader<span class="token punctuation">.</span>Builder builder<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token comment">// example only, Markwon doesn't come with a ftp scheme handler</span>
|
|
builder<span class="token punctuation">.</span><span class="token function">addSchemeHandler</span><span class="token punctuation">(</span><span class="token string">"ftp"</span><span class="token punctuation">,</span> <span class="token keyword">new</span> <span class="token class-name">FtpSchemeHandler</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span><span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
</code></pre></div><p>It's a class to <em>convert</em> an URI into an <code>InputStream</code>:</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">public</span> <span class="token keyword">abstract</span> <span class="token keyword">class</span> <span class="token class-name">SchemeHandler</span> <span class="token punctuation">{</span>
|
|
|
|
<span class="token annotation punctuation">@Nullable</span>
|
|
<span class="token keyword">public</span> <span class="token keyword">abstract</span> ImageItem <span class="token function">handle</span><span class="token punctuation">(</span><span class="token annotation punctuation">@NonNull</span> String raw<span class="token punctuation">,</span> <span class="token annotation punctuation">@NonNull</span> Uri uri<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
</code></pre></div><p><code>ImageItem</code> is a holder class for resulting <code>InputStream</code> and (optional)
|
|
content type:</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">public</span> <span class="token keyword">class</span> <span class="token class-name">ImageItem</span> <span class="token punctuation">{</span>
|
|
|
|
<span class="token keyword">private</span> <span class="token keyword">final</span> String contentType<span class="token punctuation">;</span>
|
|
<span class="token keyword">private</span> <span class="token keyword">final</span> InputStream inputStream<span class="token punctuation">;</span>
|
|
|
|
<span class="token comment">/* rest omitted */</span>
|
|
<span class="token punctuation">}</span>
|
|
</code></pre></div><p>Based on <code>contentType</code> returned a corresponding <code>MediaDecoder</code> will be matched.
|
|
If no <code>MediaDecoder</code> can handle given <code>contentType</code> then a default media decoder will
|
|
be used.</p> <h2 id="mediadecoder"><a href="#mediadecoder" aria-hidden="true" class="header-anchor">#</a> MediaDecoder</h2> <p>By default <code>core</code> artifact comes with <em>default image decoder</em> only. It's called
|
|
<code>ImageMediaDecoder</code> and it can decode all the formats that <code>BitmapFactory#decodeStream(InputStream)</code>
|
|
can.</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">final</span> Markwon markwon <span class="token operator">=</span> Markwon<span class="token punctuation">.</span><span class="token function">builder</span><span class="token punctuation">(</span><span class="token keyword">this</span><span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">usePlugin</span><span class="token punctuation">(</span>ImagesPlugin<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token keyword">this</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">usePlugin</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">AbstractMarkwonPlugin</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token annotation punctuation">@Override</span>
|
|
<span class="token keyword">public</span> <span class="token keyword">void</span> <span class="token function">configureImages</span><span class="token punctuation">(</span><span class="token annotation punctuation">@NonNull</span> AsyncDrawableLoader<span class="token punctuation">.</span>Builder builder<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
builder<span class="token punctuation">.</span><span class="token function">addMediaDecoder</span><span class="token punctuation">(</span><span class="token string">"text/plain"</span><span class="token punctuation">,</span> <span class="token keyword">new</span> <span class="token class-name">TextPlainMediaDecoder</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span><span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
|
|
</code></pre></div><p><code>MediaDecoder</code> is a class to turn <code>InputStream</code> into a <code>Drawable</code>:</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">public</span> <span class="token keyword">abstract</span> <span class="token keyword">class</span> <span class="token class-name">MediaDecoder</span> <span class="token punctuation">{</span>
|
|
|
|
<span class="token annotation punctuation">@Nullable</span>
|
|
<span class="token keyword">public</span> <span class="token keyword">abstract</span> Drawable <span class="token function">decode</span><span class="token punctuation">(</span><span class="token annotation punctuation">@NonNull</span> InputStream inputStream<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
</code></pre></div><div class="tip custom-block"><p class="custom-block-title">TIP</p> <p>If you want to display GIF or SVG images also, you can use <a href="/Markwon/docs/v3/image/gif.html">image-gif</a>
|
|
and <a href="/Markwon/docs/v3/image/svg.html">image-svg</a> modules.</p></div> <div class="tip custom-block"><p class="custom-block-title">TIP</p> <p>If you are using <a href="/Markwon/docs/v3/html/">html</a> you do not have to additionally setup
|
|
images displayed via <code><img></code> tag, as <code>HtmlPlugin</code> automatically uses configured
|
|
image loader. But images referenced in HTML come with additional support for
|
|
sizes, which is not supported natively by markdown, allowing absolute or relative sizes:</p> <div class="language-html extra-class"><pre class="language-html"><code><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>img</span> <span class="token attr-name">src</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>./assets/my-image<span class="token punctuation">"</span></span> <span class="token attr-name">width</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>100%<span class="token punctuation">"</span></span><span class="token punctuation">></span></span>
|
|
</code></pre></div></div> <h2 id="placeholder-drawable"><a href="#placeholder-drawable" aria-hidden="true" class="header-anchor">#</a> Placeholder drawable <span class="badge tip top" data-v-099ab69c>3.0.0</span></h2> <p>It's possible to provide a custom placeholder for an image (whilst it's loading).</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">final</span> Markwon markwon <span class="token operator">=</span> Markwon<span class="token punctuation">.</span><span class="token function">builder</span><span class="token punctuation">(</span>context<span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">usePlugin</span><span class="token punctuation">(</span>ImagesPlugin<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span>context<span class="token punctuation">)</span><span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">usePlugin</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">AbstractMarkwonPlugin</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token annotation punctuation">@Override</span>
|
|
<span class="token keyword">public</span> <span class="token keyword">void</span> <span class="token function">configureImages</span><span class="token punctuation">(</span><span class="token annotation punctuation">@NonNull</span> AsyncDrawableLoader<span class="token punctuation">.</span>Builder builder<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
builder<span class="token punctuation">.</span><span class="token function">placeholderDrawableProvider</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">AsyncDrawableLoader<span class="token punctuation">.</span>DrawableProvider</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token annotation punctuation">@Override</span>
|
|
<span class="token keyword">public</span> Drawable <span class="token function">provide</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token comment">// your custom placeholder drawable</span>
|
|
<span class="token keyword">return</span> <span class="token keyword">new</span> <span class="token class-name">PlaceholderDrawable</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
</code></pre></div><h2 id="error-drawable"><a href="#error-drawable" aria-hidden="true" class="header-anchor">#</a> Error drawable <span class="badge tip top" data-v-099ab69c>3.0.0</span></h2> <p>To fallback in case of error whilst loading an image, an <code>error drawable</code> can be used:</p> <div class="language-java extra-class"><pre class="language-java"><code><span class="token keyword">final</span> Markwon markwon <span class="token operator">=</span> Markwon<span class="token punctuation">.</span><span class="token function">builder</span><span class="token punctuation">(</span>context<span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">usePlugin</span><span class="token punctuation">(</span>ImagesPlugin<span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span>context<span class="token punctuation">)</span><span class="token punctuation">)</span>
|
|
<span class="token punctuation">.</span><span class="token function">usePlugin</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">AbstractMarkwonPlugin</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token annotation punctuation">@Override</span>
|
|
<span class="token keyword">public</span> <span class="token keyword">void</span> <span class="token function">configureImages</span><span class="token punctuation">(</span><span class="token annotation punctuation">@NonNull</span> AsyncDrawableLoader<span class="token punctuation">.</span>Builder builder<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
builder<span class="token punctuation">.</span><span class="token function">errorDrawableProvider</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">AsyncDrawableLoader<span class="token punctuation">.</span>DrawableProvider</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token annotation punctuation">@Override</span>
|
|
<span class="token keyword">public</span> Drawable <span class="token function">provide</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
<span class="token comment">// your custom error drawable</span>
|
|
<span class="token keyword">return</span> <span class="token keyword">new</span> <span class="token class-name">MyErrorDrawable</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
</code></pre></div><div class="warning custom-block"><p class="custom-block-title">WARNING</p> <p>Before <code>3.0.0</code> <code>AsyncDrawableLoader</code> accepted a simple <code>Drawable</code> as error drawable
|
|
argument. Starting <code>3.0.0</code> it accepts a <code>DrawableProvider</code> instead.</p></div></div> <div class="page-edit"><!----> <div class="last-updated"><span class="prefix">Last Updated: </span> <span class="time">8/6/2019, 7:27:20 PM</span></div></div> <div class="page-nav"><p class="inner"><span class="prev">
|
|
←
|
|
<a href="/Markwon/docs/v3/core/theme.html" class="prev">
|
|
Theme
|
|
</a></span> <span class="next"><a href="/Markwon/docs/v3/core/configuration.html">
|
|
Configuration
|
|
</a>
|
|
→
|
|
</span></p></div> </div> <!----></div></div>
|
|
<script src="/Markwon/assets/js/35.1684da38.js" defer></script><script src="/Markwon/assets/js/3.eaac0903.js" defer></script><script src="/Markwon/assets/js/12.98308542.js" defer></script><script src="/Markwon/assets/js/app.bdfd2bc6.js" defer></script>
|
|
</body>
|
|
</html>
|