Skip to content

Commit

Permalink
Improved documentation; canvas refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
defano committed Jan 21, 2017
1 parent ac173c5 commit 58bf881
Show file tree
Hide file tree
Showing 37 changed files with 442 additions and 333 deletions.
34 changes: 17 additions & 17 deletions docs/com/defano/jmonet/canvas/BasicPaintCanvas.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/com/defano/jmonet/canvas/JFXCanvasNode.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h2 title="Class JFXCanvasNode" class="title">Class JFXCanvasNode</h2>
<li>javafx.embed.swing.SwingNode</li>
<li>
<ul class="inheritance">
<li>com.defano.jmonet.canvas.JFXCanvasNode</li>
<li>com.defano.jmonet.canvas.JFXPaintCanvas</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -173,7 +173,7 @@ <h3>Constructor Summary</h3>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/defano/jmonet/canvas/JFXCanvasNode.html#JFXCanvasNode-com.defano.jmonet.canvas.BasicPaintCanvas-">JFXCanvasNode</a></span>(<a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html" title="class in com.defano.jmonet.canvas">BasicPaintCanvas</a>&nbsp;canvas)</code>&nbsp;</td>
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/defano/jmonet/canvas/JFXCanvasNode.html#JFXCanvasNode-com.defano.jmonet.canvas.AbstractPaintCanvas-">JFXCanvasNode</a></span>(<a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html" title="class in com.defano.jmonet.canvas">BasicPaintCanvas</a>&nbsp;canvas)</code>&nbsp;</td>
</tr>
</table>
</li>
Expand Down
10 changes: 5 additions & 5 deletions docs/com/defano/jmonet/canvas/PaintCanvas.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h3>Method Summary</h3>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/defano/jmonet/canvas/PaintCanvas.html#addCanvasCommitObserver-com.defano.jmonet.canvas.CanvasCommitObserver-">addCanvasCommitObserver</a></span>(<a href="../../../../com/defano/jmonet/canvas/CanvasCommitObserver.html" title="interface in com.defano.jmonet.canvas">CanvasCommitObserver</a>&nbsp;observer)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/defano/jmonet/canvas/PaintCanvas.html#addCanvasCommitObserver-com.defano.jmonet.canvas.observable.CanvasCommitObserver-">addCanvasCommitObserver</a></span>(<a href="../../../../com/defano/jmonet/canvas/CanvasCommitObserver.html" title="interface in com.defano.jmonet.canvas">CanvasCommitObserver</a>&nbsp;observer)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
Expand Down Expand Up @@ -171,7 +171,7 @@ <h3>Method Summary</h3>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/defano/jmonet/canvas/PaintCanvas.html#removeCanvasCommitObserver-com.defano.jmonet.canvas.CanvasCommitObserver-">removeCanvasCommitObserver</a></span>(<a href="../../../../com/defano/jmonet/canvas/CanvasCommitObserver.html" title="interface in com.defano.jmonet.canvas">CanvasCommitObserver</a>&nbsp;observer)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/defano/jmonet/canvas/PaintCanvas.html#removeCanvasCommitObserver-com.defano.jmonet.canvas.observable.CanvasCommitObserver-">removeCanvasCommitObserver</a></span>(<a href="../../../../com/defano/jmonet/canvas/CanvasCommitObserver.html" title="interface in com.defano.jmonet.canvas">CanvasCommitObserver</a>&nbsp;observer)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
Expand Down Expand Up @@ -209,18 +209,18 @@ <h3>Method Summary</h3>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.defano.jmonet.canvas.surface.ScalableScratchDrawable">
<li class="blockList"><a name="methods.inherited.from.class.com.defano.jmonet.canvas.surface.ScalableLayeredPainting">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.defano.jmonet.canvas.surface.<a href="../../../../com/defano/jmonet/canvas/surface/ScalableScratchDrawable.html" title="interface in com.defano.jmonet.canvas.surface">ScalableScratchDrawable</a></h3>
<code><a href="../../../../com/defano/jmonet/canvas/surface/ScalableScratchDrawable.html#convertPointToImage-java.awt.Point-">convertPointToImage</a>, <a href="../../../../com/defano/jmonet/canvas/surface/ScalableScratchDrawable.html#getCanvasImage--">getCanvasImage</a>, <a href="../../../../com/defano/jmonet/canvas/surface/ScalableScratchDrawable.html#getScale--">getScale</a>, <a href="../../../../com/defano/jmonet/canvas/surface/ScalableScratchDrawable.html#getScratchImage--">getScratchImage</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.defano.jmonet.canvas.surface.Surface">
<li class="blockList"><a name="methods.inherited.from.class.com.defano.jmonet.canvas.observable.ObservableSurface">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.defano.jmonet.canvas.surface.<a href="../../../../com/defano/jmonet/canvas/surface/Surface.html" title="interface in com.defano.jmonet.canvas.surface">Surface</a></h3>
<code><a href="../../../../com/defano/jmonet/canvas/surface/Surface.html#addComponent-java.awt.Component-">addComponent</a>, <a href="../../../../com/defano/jmonet/canvas/surface/Surface.html#addSurfaceInteractionObserver-com.defano.jmonet.canvas.SurfaceInteractionObserver-">addSurfaceInteractionObserver</a>, <a href="../../../../com/defano/jmonet/canvas/surface/Surface.html#removeComponent-java.awt.Component-">removeComponent</a>, <a href="../../../../com/defano/jmonet/canvas/surface/Surface.html#removeSurfaceInteractionObserver-com.defano.jmonet.canvas.SurfaceInteractionObserver-">removeSurfaceInteractionObserver</a></code></li>
<code><a href="../../../../com/defano/jmonet/canvas/surface/Surface.html#addComponent-java.awt.Component-">addComponent</a>, <a href="../../../../com/defano/jmonet/canvas/surface/Surface.html#addSurfaceInteractionObserver-com.defano.jmonet.canvas.observable.SurfaceInteractionObserver-">addSurfaceInteractionObserver</a>, <a href="../../../../com/defano/jmonet/canvas/surface/Surface.html#removeComponent-java.awt.Component-">removeComponent</a>, <a href="../../../../com/defano/jmonet/canvas/surface/Surface.html#removeSurfaceInteractionObserver-com.defano.jmonet.canvas.observable.SurfaceInteractionObserver-">removeSurfaceInteractionObserver</a></code></li>
</ul>
</li>
</ul>
Expand Down
8 changes: 4 additions & 4 deletions docs/com/defano/jmonet/canvas/UndoablePaintCanvas.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h2 title="Class UndoablePaintCanvas" class="title">Class UndoablePaintCanvas</h
<li><a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html" title="class in com.defano.jmonet.canvas.surface">com.defano.jmonet.canvas.surface.AbstractScrollableSurface</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html" title="class in com.defano.jmonet.canvas">com.defano.jmonet.canvas.BasicPaintCanvas</a></li>
<li><a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html" title="class in com.defano.jmonet.canvas">com.defano.jmonet.canvas.AbstractPaintCanvas</a></li>
<li>
<ul class="inheritance">
<li>com.defano.jmonet.canvas.UndoablePaintCanvas</li>
Expand Down Expand Up @@ -315,18 +315,18 @@ <h3>Method Summary</h3>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.defano.jmonet.canvas.BasicPaintCanvas">
<li class="blockList"><a name="methods.inherited.from.class.com.defano.jmonet.canvas.AbstractPaintCanvas">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.defano.jmonet.canvas.<a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html" title="class in com.defano.jmonet.canvas">BasicPaintCanvas</a></h3>
<code><a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#addCanvasCommitObserver-com.defano.jmonet.canvas.CanvasCommitObserver-">addCanvasCommitObserver</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#addComponent-java.awt.Component-">addComponent</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#addSurfaceInteractionObserver-com.defano.jmonet.canvas.SurfaceInteractionObserver-">addSurfaceInteractionObserver</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#clearCanvas--">clearCanvas</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#clearScratch--">clearScratch</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#commit--">commit</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#convertPointToImage-java.awt.Point-">convertPointToImage</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#fireCanvasCommitObservers-com.defano.jmonet.canvas.PaintCanvas-java.awt.image.BufferedImage-java.awt.image.BufferedImage-">fireCanvasCommitObservers</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#getGridSpacingProvider--">getGridSpacingProvider</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#getScale--">getScale</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#getScaleProvider--">getScaleProvider</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#getScratchImage--">getScratchImage</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#overlayChangeSet-com.defano.jmonet.canvas.ChangeSet-java.awt.image.BufferedImage-">overlayChangeSet</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#overlayImage-java.awt.image.BufferedImage-java.awt.image.BufferedImage-java.awt.AlphaComposite-">overlayImage</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#removeCanvasCommitObserver-com.defano.jmonet.canvas.CanvasCommitObserver-">removeCanvasCommitObserver</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#removeComponent-java.awt.Component-">removeComponent</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#removeSurfaceInteractionObserver-com.defano.jmonet.canvas.SurfaceInteractionObserver-">removeSurfaceInteractionObserver</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#setCanvasImage-java.awt.image.BufferedImage-">setCanvasImage</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#setGridSpacing-int-">setGridSpacing</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#setScale-double-">setScale</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#setScratchImage-java.awt.image.BufferedImage-">setScratchImage</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#setSize-int-int-">setSize</a></code></li>
<code><a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#addCanvasCommitObserver-com.defano.jmonet.canvas.observable.CanvasCommitObserver-">addCanvasCommitObserver</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#addComponent-java.awt.Component-">addComponent</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#addSurfaceInteractionObserver-com.defano.jmonet.canvas.observable.SurfaceInteractionObserver-">addSurfaceInteractionObserver</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#clearCanvas--">clearCanvas</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#clearScratch--">clearScratch</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#commit--">commit</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#convertPointToImage-java.awt.Point-">convertPointToImage</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#fireCanvasCommitObservers-com.defano.jmonet.canvas.PaintCanvas-java.awt.image.BufferedImage-java.awt.image.BufferedImage-">fireCanvasCommitObservers</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#getGridSpacingProvider--">getGridSpacingProvider</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#getScale--">getScale</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#getScaleProvider--">getScaleProvider</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#getScratchImage--">getScratchImage</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#overlayChangeSet-com.defano.jmonet.canvas.ChangeSet-java.awt.image.BufferedImage-">overlayChangeSet</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#overlayImage-java.awt.image.BufferedImage-java.awt.image.BufferedImage-java.awt.AlphaComposite-">overlayImage</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#removeCanvasCommitObserver-com.defano.jmonet.canvas.observable.CanvasCommitObserver-">removeCanvasCommitObserver</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#removeComponent-java.awt.Component-">removeComponent</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#removeSurfaceInteractionObserver-com.defano.jmonet.canvas.observable.SurfaceInteractionObserver-">removeSurfaceInteractionObserver</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#setCanvasImage-java.awt.image.BufferedImage-">setCanvasImage</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#setGridSpacing-int-">setGridSpacing</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#setScale-double-">setScale</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#setScratchImage-java.awt.image.BufferedImage-">setScratchImage</a>, <a href="../../../../com/defano/jmonet/canvas/BasicPaintCanvas.html#setSize-int-int-">setSize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.defano.jmonet.canvas.surface.AbstractScrollableSurface">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.defano.jmonet.canvas.surface.<a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html" title="class in com.defano.jmonet.canvas.surface">AbstractScrollableSurface</a></h3>
<code><a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#getSurface--">getSurface</a>, <a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#invalidateCanvas--">invalidateCanvas</a>, <a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#setScrollPosition-double-double-">setScrollPosition</a>, <a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#setSurface-com.defano.jmonet.canvas.surface.PaintSurface-">setSurface</a>, <a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#updateScroll--">updateScroll</a></code></li>
<code><a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#getSurface--">getSurface</a>, <a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#invalidateCanvas--">invalidateCanvas</a>, <a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#setScrollPosition-double-double-">setScrollPosition</a>, <a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#setSurface-com.defano.jmonet.canvas.surface.PaintableSurface-">setSurface</a>, <a href="../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#updateScroll--">updateScroll</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.swing.JScrollPane">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ <h3>Method Summary</h3>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#setSurface-com.defano.jmonet.canvas.surface.PaintSurface-">setSurface</a></span>(<a href="../../../../../com/defano/jmonet/canvas/surface/PaintSurface.html" title="class in com.defano.jmonet.canvas.surface">PaintSurface</a>&nbsp;surface)</code>&nbsp;</td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/defano/jmonet/canvas/surface/AbstractScrollableSurface.html#setSurface-com.defano.jmonet.canvas.surface.PaintableSurface-">setSurface</a></span>(<a href="../../../../../com/defano/jmonet/canvas/surface/PaintSurface.html" title="class in com.defano.jmonet.canvas.surface">PaintSurface</a>&nbsp;surface)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
Expand Down
Loading

0 comments on commit 58bf881

Please sign in to comment.