mirror of
https://github.com/bringout/oca-storage.git
synced 2026-04-20 01:32:06 +02:00
Initial commit: OCA Storage packages (17 packages)
This commit is contained in:
Ernad Husremovic
commit
7a380f05d3
659 changed files with 41828 additions and 0 deletions
Binary file not shown.
|
After Width: | Height: | Size: 9.2 KiB |
|
|
@ -0,0 +1,591 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
|
||||
<title>Fs Image</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
Despite the name, some widely supported CSS2 features are used.
|
||||
|
||||
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: gray; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic, pre.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="fs-image">
|
||||
<h1 class="title">Fs Image</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:720789db007b07811c46c77857a24c41551a6f2554c9517630613347c8447f80
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/storage/tree/16.0/fs_image"><img alt="OCA/storage" src="https://img.shields.io/badge/github-OCA%2Fstorage-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/storage-16-0/storage-16-0-fs_image"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/storage&target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
|
||||
<p>This addon defines a new field <strong>FSImage</strong> to use in your models. It is a
|
||||
subclass of the <strong>FSFile</strong> field and comes with the same features. It extends
|
||||
the <strong>FSFile</strong> field with specific properties dedicated to images. On the field
|
||||
definition, the following additional properties are available:</p>
|
||||
<ul class="simple">
|
||||
<li><strong>max_width</strong> (int): maximum width of the image in pixels (default: <tt class="docutils literal">0</tt>, no limit)</li>
|
||||
<li><strong>max_height</strong> (int): maximum height of the image in pixels (default: <tt class="docutils literal">0</tt>, no limit)</li>
|
||||
<li><strong>verify_resolution</strong> (bool):whether the image resolution should be verified
|
||||
to ensure it doesn’t go over the maximum image resolution (default: <tt class="docutils literal">True</tt>).
|
||||
See <cite>odoo.tools.image.ImageProcess</cite> for maximum image resolution (default: <tt class="docutils literal">50e6</tt>).</li>
|
||||
</ul>
|
||||
<p>On the field’s value side, the value is an instance of a subclass of
|
||||
<cite>odoo.addons.fs_file.fields.FSFileValue</cite>. It extends the class to allows
|
||||
you to manage an alt_text for the image. The alt_text is a text that will be
|
||||
displayed when the image cannot be displayed.</p>
|
||||
<div class="admonition important">
|
||||
<p class="first admonition-title">Important</p>
|
||||
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
|
||||
Only for development or testing purpose, do not use in production.
|
||||
<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
|
||||
</div>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
|
||||
<li><a class="reference internal" href="#changelog" id="toc-entry-2">Changelog</a><ul>
|
||||
<li><a class="reference internal" href="#section-1" id="toc-entry-3">16.0.1.0.3 (2024-02-23)</a></li>
|
||||
<li><a class="reference internal" href="#section-2" id="toc-entry-4">16.0.1.0.2 (2023-12-02)</a></li>
|
||||
<li><a class="reference internal" href="#section-3" id="toc-entry-5">16.0.1.0.1 (2023-12-02)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-6">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="toc-entry-7">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="toc-entry-8">Authors</a></li>
|
||||
<li><a class="reference internal" href="#contributors" id="toc-entry-9">Contributors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="toc-entry-10">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
|
||||
<p>This new field type can be used in the same way as the odoo ‘Image’ field type.</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="kn">from</span> <span class="nn">odoo</span> <span class="kn">import</span> <span class="n">models</span><span class="w">
|
||||
</span><span class="kn">from</span> <span class="nn">odoo.addons.fs_image.fields</span> <span class="kn">import</span> <span class="n">FSImage</span><span class="w">
|
||||
|
||||
</span><span class="k">class</span> <span class="nc">MyModel</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span><span class="w">
|
||||
</span> <span class="n">_name</span> <span class="o">=</span> <span class="s1">'my.model'</span><span class="w">
|
||||
|
||||
</span> <span class="n">image</span> <span class="o">=</span> <span class="n">FSImage</span><span class="p">(</span><span class="s1">'Image'</span><span class="p">,</span> <span class="n">max_width</span><span class="o">=</span><span class="mi">1920</span><span class="p">,</span> <span class="n">max_height</span><span class="o">=</span><span class="mi">1920</span><span class="p">)</span>
|
||||
</pre>
|
||||
<pre class="code xml literal-block">
|
||||
<span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"my_model_form"</span><span class="w"> </span><span class="na">model=</span><span class="s">"ir.ui.view"</span><span class="nt">></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>my.model.form<span class="nt"></field></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"model"</span><span class="nt">></span>my.model<span class="nt"></field></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"arch"</span><span class="w"> </span><span class="na">type=</span><span class="s">"xml"</span><span class="nt">></span><span class="w">
|
||||
</span><span class="nt"><form></span><span class="w">
|
||||
</span><span class="nt"><sheet></span><span class="w">
|
||||
</span><span class="nt"><group></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"image"</span><span class="w"> </span><span class="na">class=</span><span class="s">"oe_avatar"</span><span class="nt">/></span><span class="w">
|
||||
</span><span class="nt"></group></span><span class="w">
|
||||
</span><span class="nt"></sheet></span><span class="w">
|
||||
</span><span class="nt"></form></span><span class="w">
|
||||
</span><span class="nt"></field></span><span class="w">
|
||||
</span><span class="nt"></record></span>
|
||||
</pre>
|
||||
<p>In the example above, the image will be resized to 1920x1920px if it is larger than that.
|
||||
The widget used in the form view will also allow the user set an ‘alt’ text for the image.</p>
|
||||
<p>A mode advanced and useful example is the following:</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="kn">from</span> <span class="nn">odoo</span> <span class="kn">import</span> <span class="n">models</span><span class="w">
|
||||
</span><span class="kn">from</span> <span class="nn">odoo.addons.fs_image.fields</span> <span class="kn">import</span> <span class="n">FSImage</span><span class="w">
|
||||
|
||||
</span><span class="k">class</span> <span class="nc">MyModel</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span><span class="w">
|
||||
</span> <span class="n">_name</span> <span class="o">=</span> <span class="s1">'my.model'</span><span class="w">
|
||||
|
||||
</span> <span class="n">image_1920</span> <span class="o">=</span> <span class="n">FSImage</span><span class="p">(</span><span class="s1">'Image'</span><span class="p">,</span> <span class="n">max_width</span><span class="o">=</span><span class="mi">1920</span><span class="p">,</span> <span class="n">max_height</span><span class="o">=</span><span class="mi">1920</span><span class="p">)</span><span class="w">
|
||||
</span> <span class="n">image_128</span> <span class="o">=</span> <span class="n">FSImage</span><span class="p">(</span><span class="s1">'Image'</span><span class="p">,</span> <span class="n">max_width</span><span class="o">=</span><span class="mi">128</span><span class="p">,</span> <span class="n">max_height</span><span class="o">=</span><span class="mi">128</span><span class="p">,</span> <span class="n">related</span><span class="o">=</span><span class="s1">'image_1920'</span><span class="p">,</span> <span class="n">store</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
</pre>
|
||||
<pre class="code xml literal-block">
|
||||
<span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"my_model_form"</span><span class="w"> </span><span class="na">model=</span><span class="s">"ir.ui.view"</span><span class="nt">></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>my.model.form<span class="nt"></field></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"model"</span><span class="nt">></span>my.model<span class="nt"></field></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"arch"</span><span class="w"> </span><span class="na">type=</span><span class="s">"xml"</span><span class="nt">></span><span class="w">
|
||||
</span><span class="nt"><form></span><span class="w">
|
||||
</span><span class="nt"><sheet></span><span class="w">
|
||||
</span><span class="nt"><group></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w">
|
||||
</span><span class="na">name=</span><span class="s">"image_1920"</span><span class="w">
|
||||
</span><span class="na">class=</span><span class="s">"oe_avatar"</span><span class="w">
|
||||
</span><span class="na">options=</span><span class="s">"{'preview_image': 'image_128', 'zoom': true}"</span><span class="w">
|
||||
</span><span class="nt">/></span><span class="w">
|
||||
</span><span class="nt"></group></span><span class="w">
|
||||
</span><span class="nt"></sheet></span><span class="w">
|
||||
</span><span class="nt"></form></span><span class="w">
|
||||
</span><span class="nt"></field></span><span class="w">
|
||||
</span><span class="nt"></record></span>
|
||||
</pre>
|
||||
<p>In the example above we have two fields, one for the original image and one for a thumbnail.
|
||||
As the thumbnail is defined as a related stored field it’s automatically generated
|
||||
from the original image, resized at the given size and stored in the database.
|
||||
The thumbnail is then used as a preview image for the original image in the form view.
|
||||
The main advantage of this approach is that the original image is not loaded in the form view
|
||||
and the thumbnail is used instead, which is much smaller in size and faster to load.
|
||||
The ‘zoom’ option allows the user to see the original image in a popup when clicking on the thumbnail.</p>
|
||||
<p>For convenience, the ‘fs_image’ module also provides a ‘FSImageMixin’ mixin class
|
||||
that can be used to add the ‘image’ and ‘image_medium’ fields to a model. It only
|
||||
define the medium thumbnail as a 128x128px image since it’s the most common use case.
|
||||
When using an image field in a model, it’s recommended to use this mixin class
|
||||
in order ensure that the ‘image_medium’ field is always defined. A good practice
|
||||
is to use the <cite>image_medium</cite> field as a preview image for the <cite>image</cite> field in
|
||||
the form view to avoid to overload the form view with a large image and consume
|
||||
too much bandwidth.</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="kn">from</span> <span class="nn">odoo</span> <span class="kn">import</span> <span class="n">models</span><span class="w">
|
||||
|
||||
</span><span class="k">class</span> <span class="nc">MyModel</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span><span class="w">
|
||||
</span> <span class="n">_name</span> <span class="o">=</span> <span class="s1">'my.model'</span><span class="w">
|
||||
</span> <span class="n">_inherit</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'fs_image.mixin'</span><span class="p">]</span>
|
||||
</pre>
|
||||
<pre class="code xml literal-block">
|
||||
<span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"my_model_form"</span><span class="w"> </span><span class="na">model=</span><span class="s">"ir.ui.view"</span><span class="nt">></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>my.model.form<span class="nt"></field></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"model"</span><span class="nt">></span>my.model<span class="nt"></field></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"arch"</span><span class="w"> </span><span class="na">type=</span><span class="s">"xml"</span><span class="nt">></span><span class="w">
|
||||
</span><span class="nt"><form></span><span class="w">
|
||||
</span><span class="nt"><sheet></span><span class="w">
|
||||
</span><span class="nt"><group></span><span class="w">
|
||||
</span><span class="nt"><field</span><span class="w">
|
||||
</span><span class="na">name=</span><span class="s">"image"</span><span class="w">
|
||||
</span><span class="na">class=</span><span class="s">"oe_avatar"</span><span class="w">
|
||||
</span><span class="na">options=</span><span class="s">"{'preview_image': 'image_medium', 'zoom': true}"</span><span class="w">
|
||||
</span><span class="nt">/></span><span class="w">
|
||||
</span><span class="nt"></group></span><span class="w">
|
||||
</span><span class="nt"></sheet></span><span class="w">
|
||||
</span><span class="nt"></form></span><span class="w">
|
||||
</span><span class="nt"></field></span><span class="w">
|
||||
</span><span class="nt"></record></span>
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section" id="changelog">
|
||||
<h1><a class="toc-backref" href="#toc-entry-2">Changelog</a></h1>
|
||||
<div class="section" id="section-1">
|
||||
<h2><a class="toc-backref" href="#toc-entry-3">16.0.1.0.3 (2024-02-23)</a></h2>
|
||||
<p><strong>Bugfixes</strong></p>
|
||||
<ul class="simple">
|
||||
<li>(<a class="reference external" href="https://github.com/OCA/storage/issues/305">#305</a>)</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="section-2">
|
||||
<h2><a class="toc-backref" href="#toc-entry-4">16.0.1.0.2 (2023-12-02)</a></h2>
|
||||
<p><strong>Bugfixes</strong></p>
|
||||
<ul>
|
||||
<li><p class="first">Fix view crash when uploading an image</p>
|
||||
<p>The rawCacheKey is appropriately managed by the base class and reflects the
|
||||
record’s last update datetime (write_date).
|
||||
Since it lacks a setter, attempting to invalidate its value results in a view crash.
|
||||
Nevertheless, the value will automatically be updated upon saving the record. (<a class="reference external" href="https://github.com/OCA/storage/issues/305">#305</a>)</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="section-3">
|
||||
<h2><a class="toc-backref" href="#toc-entry-5">16.0.1.0.1 (2023-12-02)</a></h2>
|
||||
<p><strong>Bugfixes</strong></p>
|
||||
<ul>
|
||||
<li><p class="first">Avoid to generate an SQL update query when an image field is read.</p>
|
||||
<p>Fix a bug in the initialization of the image field value object when the field
|
||||
is read. Before this fix, every time the value object was initialized with
|
||||
an attachment, an assignment of the alt text was done into the constructor.
|
||||
This assignment triggered the mark of the field as modified and an SQL update
|
||||
query was generated at the end of the request. The alt text in the constructor
|
||||
of the FSImageValue class must only be used when the class is initialized without
|
||||
an attachment. We now check if an attachment and an alt text are provided at
|
||||
the same time and throw an exception if this is the case. (<a class="reference external" href="https://github.com/OCA/storage/issues/307">#307</a>)</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#toc-entry-6">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/storage/issues">GitHub Issues</a>.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||
<a class="reference external" href="https://github.com/OCA/storage/issues/new?body=module:%20fs_image%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#toc-entry-7">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#toc-entry-8">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>ACSONE SA/NV</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2><a class="toc-backref" href="#toc-entry-9">Contributors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Laurent Mignon <<a class="reference external" href="mailto:laurent.mignon@acsone.eu">laurent.mignon@acsone.eu</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#toc-entry-10">Maintainers</a></h2>
|
||||
<p>This module is maintained by the OCA.</p>
|
||||
<a class="reference external image-reference" href="https://odoo-community.org">
|
||||
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
|
||||
</a>
|
||||
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||
mission is to support the collaborative development of Odoo features and
|
||||
promote its widespread use.</p>
|
||||
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
|
||||
<p><a class="reference external image-reference" href="https://github.com/lmignon"><img alt="lmignon" src="https://github.com/lmignon.png?size=40px" /></a></p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/storage/tree/16.0/fs_image">OCA/storage</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
.fs_file_download_button {
|
||||
top: 10% !important;
|
||||
left: 50% !important;
|
||||
position: absolute !important;
|
||||
}
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
/** @odoo-module */
|
||||
|
||||
/**
|
||||
* Copyright 2023 ACSONE SA/NV
|
||||
*/
|
||||
|
||||
import {Dialog} from "@web/core/dialog/dialog";
|
||||
|
||||
const {Component, useRef} = owl;
|
||||
|
||||
export class AltTextDialog extends Component {
|
||||
setup() {
|
||||
this.altText = useRef("altText");
|
||||
}
|
||||
|
||||
async onClose() {
|
||||
if (this.props.close) {
|
||||
this.props.close();
|
||||
}
|
||||
}
|
||||
|
||||
async onConfirm() {
|
||||
try {
|
||||
await this.props.confirm(this.altText.el.value);
|
||||
} catch (e) {
|
||||
this.props.close();
|
||||
throw e;
|
||||
}
|
||||
this.onClose();
|
||||
}
|
||||
}
|
||||
|
||||
AltTextDialog.components = {Dialog};
|
||||
AltTextDialog.template = "fs_image.AltTextDialog";
|
||||
AltTextDialog.props = {
|
||||
title: String,
|
||||
altText: String,
|
||||
confirm: Function,
|
||||
close: {type: Function, optional: true},
|
||||
};
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<templates xml:space="preserve">
|
||||
<t t-name="fs_image.AltTextDialog" owl="1">
|
||||
<Dialog size="'md'" title="props.title">
|
||||
<div class="form-group row">
|
||||
<t t-if="props.readonly">
|
||||
<span t-esc="props.value or ''" />
|
||||
</t>
|
||||
<div class="col-sm-12 o_field_widget o_field_text">
|
||||
<input
|
||||
type="text"
|
||||
id="altText"
|
||||
t-ref="altText"
|
||||
t-att-value="props.altText"
|
||||
class="o_input"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
<t t-set-slot="footer" owl="1">
|
||||
<button
|
||||
class="btn btn-primary"
|
||||
t-ref="btn-confirm"
|
||||
t-on-click="onConfirm"
|
||||
>Save changes</button>
|
||||
<button
|
||||
class="btn btn-secondary"
|
||||
t-ref="btn-close"
|
||||
t-on-click="onClose"
|
||||
>Cancel</button>
|
||||
</t>
|
||||
</Dialog>
|
||||
</t>
|
||||
</templates>
|
||||
|
|
@ -0,0 +1,117 @@
|
|||
/** @odoo-module */
|
||||
|
||||
/**
|
||||
* Copyright 2023 ACSONE SA/NV
|
||||
*/
|
||||
import {
|
||||
ImageField,
|
||||
fileTypeMagicWordMap,
|
||||
imageCacheKey,
|
||||
} from "@web/views/fields/image/image_field";
|
||||
import {onWillUpdateProps, useState} from "@odoo/owl";
|
||||
|
||||
import {AltTextDialog} from "../dialogs/alttext_dialog.esm";
|
||||
import {download, downloadFile} from "@web/core/network/download";
|
||||
import {registry} from "@web/core/registry";
|
||||
import {url} from "@web/core/utils/urls";
|
||||
import {useService} from "@web/core/utils/hooks";
|
||||
|
||||
const placeholder = "/web/static/img/placeholder.png";
|
||||
|
||||
export class FSImageField extends ImageField {
|
||||
setup() {
|
||||
// Call super.setup() to initialize the state
|
||||
super.setup();
|
||||
this.state = useState({
|
||||
...this.props.value,
|
||||
...this.state,
|
||||
});
|
||||
onWillUpdateProps((nextProps) => {
|
||||
this.state.isUploading = false;
|
||||
const {filename, mimetype, alt_text, url} = nextProps.value || {};
|
||||
this.state.filename = filename;
|
||||
this.state.mimetype = mimetype;
|
||||
this.state.url = url;
|
||||
this.state.alt_text = alt_text;
|
||||
});
|
||||
this.dialogService = useService("dialog");
|
||||
}
|
||||
|
||||
getUrl(previewFieldName) {
|
||||
if (
|
||||
this.state.isValid &&
|
||||
this.props.value &&
|
||||
typeof this.props.value === "object"
|
||||
) {
|
||||
// Check if value is a dict
|
||||
if (this.props.value.content) {
|
||||
// We use the binary content of the value
|
||||
// Use magic-word technique for detecting image type
|
||||
const magic =
|
||||
fileTypeMagicWordMap[this.props.value.content[0]] || "png";
|
||||
return `data:image/${magic};base64,${this.props.value.content}`;
|
||||
}
|
||||
const model = this.props.record.resModel;
|
||||
const id = this.props.record.resId;
|
||||
let base_url = this.props.value.url;
|
||||
if (id !== undefined && id !== null && id !== false) {
|
||||
const field = previewFieldName;
|
||||
const filename = this.props.value.filename;
|
||||
base_url = `/web/image/${model}/${id}/${field}/${filename}`;
|
||||
}
|
||||
return url(base_url, {unique: imageCacheKey(this.rawCacheKey)});
|
||||
}
|
||||
return placeholder;
|
||||
}
|
||||
|
||||
get hasTooltip() {
|
||||
return this.props.enableZoom && !this.props.isDebugMode && this.props.value;
|
||||
}
|
||||
|
||||
onFileUploaded(info) {
|
||||
this.state.isValid = true;
|
||||
this.props.update({
|
||||
filename: info.name,
|
||||
content: info.data,
|
||||
});
|
||||
}
|
||||
onAltTextEdit() {
|
||||
const self = this;
|
||||
const altText = this.props.value.alt_text || "";
|
||||
const dialogProps = {
|
||||
title: this.env._t("Alt Text"),
|
||||
altText: altText,
|
||||
confirm: (value) => {
|
||||
self.props.update({
|
||||
...self.props.value,
|
||||
alt_text: value,
|
||||
});
|
||||
},
|
||||
};
|
||||
this.dialogService.add(AltTextDialog, dialogProps);
|
||||
}
|
||||
async onFileDownload() {
|
||||
if (this.props.value.content) {
|
||||
const magic = fileTypeMagicWordMap[this.props.value.content[0]] || "png";
|
||||
await downloadFile(
|
||||
`data:image/${magic};base64,${this.props.value.content}`,
|
||||
this.state.filename,
|
||||
`image/${magic}`
|
||||
);
|
||||
} else {
|
||||
await download({
|
||||
data: {
|
||||
model: this.props.record.resModel,
|
||||
id: this.props.record.resId,
|
||||
field: this.props.name,
|
||||
filename: this.state.filename || "download",
|
||||
download: true,
|
||||
},
|
||||
url: "/web/image",
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
FSImageField.template = "fs_image.FSImageField";
|
||||
registry.category("fields").add("fs_image", FSImageField);
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<templates xml:space="preserve">
|
||||
|
||||
<t t-name="fs_image.FSImageField" owl="1">
|
||||
<div class="d-inline-block position-relative opacity-trigger-hover">
|
||||
<div
|
||||
t-attf-class="position-absolute d-flex justify-content-between w-100 bottom-0 opacity-0 opacity-100-hover {{isMobile ? 'o_mobile_controls' : ''}}"
|
||||
aria-atomic="true"
|
||||
t-att-style="sizeStyle"
|
||||
>
|
||||
<t t-if="!props.readonly">
|
||||
<FileUploader
|
||||
acceptedFileExtensions="props.acceptedFileExtensions"
|
||||
t-key="props.record.resId"
|
||||
onUploaded.bind="onFileUploaded"
|
||||
type="'image'"
|
||||
>
|
||||
<t t-set-slot="toggler">
|
||||
<button
|
||||
class="o_select_file_button btn btn-light border-0 rounded-circle m-1 p-1"
|
||||
data-tooltip="Edit"
|
||||
aria-label="Edit"
|
||||
>
|
||||
<i class="fa fa-pencil fa-fw" />
|
||||
</button>
|
||||
</t>
|
||||
<t t-if="props.value and state.isValid">
|
||||
<button
|
||||
class="o_alt_text_file_button btn btn-light border-0 rounded-circle m-1 p-1"
|
||||
data-tooltip="Alt Text"
|
||||
aria-label="Set Alt Text"
|
||||
t-on-click="onAltTextEdit"
|
||||
>
|
||||
<i class="fa fa-blind fa-fw" />
|
||||
</button>
|
||||
<button
|
||||
class="o_clear_file_button btn btn-light border-0 rounded-circle m-1 p-1"
|
||||
data-tooltip="Clear"
|
||||
aria-label="Clear"
|
||||
t-on-click="onFileRemove"
|
||||
>
|
||||
<i class="fa fa-trash-o fa-fw" />
|
||||
</button>
|
||||
</t>
|
||||
</FileUploader>
|
||||
</t>
|
||||
</div>
|
||||
<img
|
||||
class="img img-fluid w-100"
|
||||
alt="Binary file"
|
||||
t-att-src="this.getUrl(props.previewImage or props.name)"
|
||||
t-att-name="props.name"
|
||||
t-att-height="props.height"
|
||||
t-att-width="props.width"
|
||||
t-att-style="sizeStyle"
|
||||
t-att-alt="props.alt"
|
||||
t-on-error.stop="onLoadFailed"
|
||||
t-att-data-tooltip-template="hasTooltip and tooltipAttributes.template"
|
||||
t-att-data-tooltip-info="hasTooltip and tooltipAttributes.info"
|
||||
t-att-data-tooltip-delay="hasTooltip and props.zoomDelay"
|
||||
/>
|
||||
<button
|
||||
t-if="props.value and state.isValid"
|
||||
class="fs_file_download_button btn btn-light border-0 rounded-circle m-1 p-1 translate-middle opacity-0 opacity-100-hover"
|
||||
data-tooltip="Download"
|
||||
aria-label="Download"
|
||||
t-on-click="onFileDownload"
|
||||
>
|
||||
<i class="fa fa-download fa-fw" />
|
||||
</button>
|
||||
|
||||
</div>
|
||||
</t>
|
||||
|
||||
</templates>
|
||||
Loading…
Add table
Add a link
Reference in a new issue