Skip to content

Commit

Permalink
- removed old java docs
Browse files Browse the repository at this point in the history
- more javadoc updates
- more refactoring
- added license base file
- api design todo
  • Loading branch information
marcello3d committed Dec 22, 2009
1 parent 2111e0c commit 6f49cce
Show file tree
Hide file tree
Showing 70 changed files with 235 additions and 6,239 deletions.
22 changes: 22 additions & 0 deletions LICENSE
@@ -0,0 +1,22 @@
/*!
* Copyright (c) 2009 Marcello Bastéa-Forte (marcello@cellosoft.com)
*
* This software is provided 'as-is', without any express or implied
* warranty. In no event will the authors be held liable for any damages
* arising from the use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software
* in a product, an acknowledgment in the product documentation would be
* appreciated but is not required.
*
* 2. Altered source versions must be plainly marked as such, and must not be
* misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source
* distribution.
*/
3 changes: 1 addition & 2 deletions build.xml
Expand Up @@ -238,8 +238,7 @@
<doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
<bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
-->
<link offline="true" href="http://java.sun.com/j2se/1.5.0/docs/api/" packagelistLoc="C:\tmp"/>
<link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>
<link href="http://java.sun.com/j2se/1.5.0/docs/api/" packagelistloc="java1.5-package-list"/>
</javadoc>
</target>

Expand Down
46 changes: 46 additions & 0 deletions design/api-design-todo.txt
@@ -0,0 +1,46 @@
API Design open questions:


====================================================================================================================
== Feature support

- JTablet doesn't implement the notion of a physical tablet device. (TabletDevice refers to individual input devices,
such as a mouse or stylus.)

If we wanted to support whole tablet features like touch strips or tablet buttons, we would need some notion of
what tablets are connected and what features they support.

Desired? Necessary?

- Currently JTablet2 implements multi-touch gesture support on Mac OS X. While this is nice, I feel the API may be a
little confusing in the context of a tablet API (especially since it never works outside of Mac OS X, and then, even
only on multitouch trackpads).

While scrolling makes sense to a certain extend, should rotate, zoom and swipe be part of the core API or separated
out somehow?

====================================================================================================================
== Naming issues

- Naming for *Listener *Event *Device classes, possibilities (or some combination of the below):
- Tablet: TabletListener, TabletEvent, TabletDevice
- pros: strong "brand" with JTablet name, usage is very clear
- cons: technically it's not just tablet input, but can be used for mouse input,
"TabletDevice" might refer to the entire tablet, not a specific stylus or input device

- Cursor: CursorListener, CursorEvent, CursorDevice
- pros: method names in the listener are already cursor* (i.e. cursorPressed, cursorReleased, etc.)
- cons: not sure if cursor implies the right thing

- Input: InputListener, InputEvent, InputDevice
- pros: most abstract,
- cons: too abstract? InputEvent already exists in java.awt.event

- Naming for Support enum:
- currently:
Support.NONE This feature is definitely not supported.
Support.SUPPORTED This feature is definitely supported.
Support.UNKNOWN It is unknown whether or not this feature is supported.
- but NONE and SUPPORTED aren't parallel


File renamed without changes.
36 changes: 0 additions & 36 deletions doc/allclasses-frame.html

This file was deleted.

36 changes: 0 additions & 36 deletions doc/allclasses-noframe.html

This file was deleted.

0 comments on commit 6f49cce

Please sign in to comment.