Basic uitable support #4

Dev-iL · 2017-11-24T10:18:04Z

Added some methods for manipulating uitables, and an accompanying demo app. Also included some minor refactoring of method names to follow Java conventions (internal functions, so no change to API).

NOTE: As of the creation of the PR, the markdown documentation wasn’t updated, so please see \Demo\TableDemo.m for a demonstration of the new functionality.

See `aboutDojo()`.

- Improved in-code documentation for some methods.

See `getHTML`.

- See `getWidgetInfo`. - Added a utility function for preallocating a `struct` based on a JSON object. - Added a utility function for unifying structs with different fieldnames.

Dev-iL · 2017-11-24T11:25:08Z

Things to do before the PR is merged (comments by @altmany):

README - fix the list of methods at the top (aboutDojo is listed at the end os setStyle, not in a separate line)
README - add explanation and usage example for aboutDojo()
README - add explanation and usage example for getWidgetInfo() and also list it at the top (list of public methods)
README - fontWeight() - clarify that 'lighter' is also accepted, and that the actual visible effect depends on the availability in the font-face that is used
mlapptools - make getWidgetInfo() accept a specific control handle (not just a uifigure handle) and return only the information relevant for this specific control
mlapptools - make getWebWindow() and getWebElements() public
mlapptools - fontweight() has a bug: needs to call mlapptools.validateFontWeight(), not .validatefontweight()
mlapptools - make QUERY_TIMEOUT public (or at least have a public setter method)
TableDemo - in ButtonPushed(), don't loop over ...:44 but rather over ...:size(w,1) - it is indeed 22 for R2017x, but may well change in R2018x, so better keep it generic...

sco1

lgtm!

sco1 · 2017-11-24T13:12:28Z

RE: 8 on your list, since we're using this as an Abstract class I'm not sure we'll be able to do this. I'd prefer not having to instantiate the class just to have a settable timeiout, so it may have to be done using a global or an external settings file that can be parsed.

altmany · 2017-11-24T13:41:38Z

re 8, you could have a setTimeout(hFig,value) function that would setappdata(hFig,'QUERY_TIMEOUT',value) and then whenever you want to check for the timeout you could do something like:

timeout = getappdata(hFig,'QUERY_TIMEOUT');
if isempty(timeout), timeout = mlapptools.QUERY_TIMEOUT; end
while true && (toc < timeout)
   ...

Iterations now use the output of `size` instead of a hard-coded value.

- Added a "shield" indicating the required MATLAB versions. - Reordered methods lexicographically. - Added link for `aboutDojo`. - Added explanation and usage example for `getHTML` and `getWidgetInfo`. - `fontWeight`- Clarified when this method has an effect; mentioned that `'lighter'` is also accepted. - Removed some of the internal documentation in `mlapptools.m`.

(`TMP_somename.m` is the convention used for temporary testing files)

+ Minor (internal) documentation changes.

+ Added relevant documentation. + Fixed bug related to a capitalization issue in `fontWeight`. + Renamed "uielement" to "uiElement" to better fit conventions. TODO: add unit tests.

Dev-iL · 2017-11-26T15:13:09Z

@sco1 @altmany I have added some more commits that address most of the suggestions above.

Regarding 5. - It was not clear to me how to achieve it, so I left it unimplemented for now. It seems to me that having both functionalities in the same method (both accepting a uifigure and a "uielement") is confusing. Instead, we can rename the current method to getWidgetListing and implement Yair's suggestion under the current name (getWidgetInfo).
Regarding 8. - I did as Yair suggested, although I had to include somewhat of a hack to make it work in all cases as expected.

Thoughts / comments?

- `getWidgetInfo` now operates on a single widget, whereas `getWidgetList` has the old functionality of `getWidgetInfo` (i.e. it accepts a `uifigure` and returns a list of widgets). The heavy lifting is done by the new `private` `decodeDijitRegistryResult` method. - README updated. - Fixed an off-by-1 bug in the widget decoding logic.

Dev-iL · 2017-11-27T11:31:52Z

Implemented 5 as explained in my previous comment. Tested all code examples manually. I think it's ready to merge now. Will wait for comments until the end of the day before merging.

sco1 · 2017-11-27T11:37:23Z

Haven't had a chance to play with the newest functionality but it still looks OK to me. I'm assuming you guys have looked at it pretty thoroughly so I'm confident that it works as desired.

Until MATLAB renders external README documents I'd prefer to keep at least a framework of the inline documentation in place so folks have at least something useful show up with doc/help. I'd still defer to the README for more in-depth information.

sco1 · 2017-11-27T11:38:58Z

Also, once this PR is merged I'll go back through and tag releases as requested...wherever it was requested.

Text is a copy of the methods summary from README.md.

altmany · 2017-11-27T14:44:15Z

Waiting for your merge to post the followup article on UndocumentedMatlab.com

altmany · 2017-11-27T15:07:07Z

https://undocumentedmatlab.com/blog/customizing-uifigures-part-3

altmany · 2017-11-27T15:14:27Z

Thanks for the great work @sco1 & @Dev-iL - very high-quality code, and nifty research indeed into the Dojo underworld :-)

I'm 100% certain that this will get MathWorks' attention, and for a very good reason - they should have included this functionality in their code ages ago.

sco1 · 2017-11-27T15:23:36Z

@altmany Fingers crossed! More than a few head scratchers with the new UI engine, as much as I love it.

I dream of a day when we can get documented methods for things like centering text without having to muck through the underlying graphics engine. Though there will always be a soft spot in my heart for the many hours spent with findjobj ☺️

Dev-iL added 6 commits October 4, 2017 16:38

Added a method to return the Dojo toolkit version.

807cbb6

See `aboutDojo()`.

Fixed some capitalization issues and added "end % comments"

112cc75

Added a 4-parameter overload to setStyle

d7e065b

- Improved in-code documentation for some methods.

Added a function to dump the HTML of a uifigure.

053d685

See `getHTML`.

Added a method for gathering information from the dijit widget registry.

940d288

- See `getWidgetInfo`. - Added a utility function for preallocating a `struct` based on a JSON object. - Added a utility function for unifying structs with different fieldnames.

Added another demo GUI for showcasing some uitable modifications.

4bc6be8

Dev-iL requested a review from sco1 November 24, 2017 10:18

sco1 approved these changes Nov 24, 2017

View reviewed changes

Dev-iL added 7 commits November 26, 2017 09:54

Made TableDemo more future-proof

33c410b

Iterations now use the output of `size` instead of a hard-coded value.

Added a license (MIT)

1071964

Ignoring TMP*.m files

05c80b4

(`TMP_somename.m` is the convention used for temporary testing files)

Reordered methods lexicographically in mlapptools.m

d7ad40d

+ Minor (internal) documentation changes.

Made getWebElements and getWebWindow public.

3bd1037

+ Added relevant documentation. + Fixed bug related to a capitalization issue in `fontWeight`. + Renamed "uielement" to "uiElement" to better fit conventions. TODO: add unit tests.

Added the setTimeout public method for modifying dojo timeout.

59d794a

Dev-iL added 3 commits November 27, 2017 12:53

Warnings will now be restored to previous state, instead of "on".

60d71b4

Updated TableDemo to work with renamed method

0c2aacf

Put the internal documentation back into mlapptools.m

80a77bf

Text is a copy of the methods summary from README.md.

Dev-iL merged commit f86cace into StackOverflowMATLABchat:develop Nov 27, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Basic uitable support #4

Basic uitable support #4

Uh oh!

Dev-iL commented Nov 24, 2017

Uh oh!

Dev-iL commented Nov 24, 2017

Uh oh!

sco1 left a comment

Uh oh!

sco1 commented Nov 24, 2017

Uh oh!

altmany commented Nov 24, 2017

Uh oh!

Dev-iL commented Nov 26, 2017

Uh oh!

Dev-iL commented Nov 27, 2017

Uh oh!

sco1 commented Nov 27, 2017

Uh oh!

sco1 commented Nov 27, 2017

Uh oh!

altmany commented Nov 27, 2017 •

edited

Loading

Uh oh!

altmany commented Nov 27, 2017

Uh oh!

altmany commented Nov 27, 2017

Uh oh!

sco1 commented Nov 27, 2017

Uh oh!

Uh oh!

Basic uitable support #4

Basic uitable support #4

Uh oh!

Conversation

Dev-iL commented Nov 24, 2017

Uh oh!

Dev-iL commented Nov 24, 2017

Uh oh!

sco1 left a comment

Choose a reason for hiding this comment

Uh oh!

sco1 commented Nov 24, 2017

Uh oh!

altmany commented Nov 24, 2017

Uh oh!

Dev-iL commented Nov 26, 2017

Uh oh!

Dev-iL commented Nov 27, 2017

Uh oh!

sco1 commented Nov 27, 2017

Uh oh!

sco1 commented Nov 27, 2017

Uh oh!

altmany commented Nov 27, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

altmany commented Nov 27, 2017

Uh oh!

altmany commented Nov 27, 2017

Uh oh!

sco1 commented Nov 27, 2017

Uh oh!

Uh oh!

altmany commented Nov 27, 2017 •

edited

Loading