Results 1 to 6 of 6

Thread: configs - getter and setter methods should not clutter the list of configs

  1. #1
    Sencha Premium User
    Join Date
    Nov 2010
    Location
    Chicago
    Posts
    2,425
    Answers
    20

    Default Answered: configs - getter and setter methods should not clutter the list of configs

    Got to this panel doc page and mouse over the configs button which lists 137 configs.

    Is it me or the various getter and setter methods massively clutter the list of all configs?

    I have a 34" monitor at work and the panel config list barely fits on the maximized doc page.

    The list of all configs should occupy a lot less space. Is it necessary to display all config getters and setters?

    Can a tooltip or a label indicate that there is a getter or a setter method attached to a config?

  2. Hi,

    We've got a feature request internally for getter / setter filtering at some stage. We'll also consider badges for undocumented (auto-generated) setter / getter documentation and leave the current view or something like it for getter / setter documentation that has been expanded beyond the basic "gets a thing" and "sets a thing".

    Thanks again for the feedback!

  3. #2
    Sencha Premium User mitchellsimoens's Avatar
    Join Date
    Mar 2007
    Location
    Gainesville, FL
    Posts
    40,392
    Answers
    3997

    Default

    For people new to Ext JS, showing the getter/setter right there with the config can be very helpful.

    I'm not sure what you mean by the config list barely fits. If the configs are collapsed, the getters/setters aren't in the way then? If the configs are expanded, the getters/setters only add to the documentation but getting rid of them wouldn't solve the issue of everything fitting as we add more and more text/examples would add to the height of things.
    Mitchell Simoens @LikelyMitch
    Modus Create, Senior Frontend Engineer
    ________________
    Need any sort of Ext JS help? Modus Create is here to help!

    Check out my GitHub:
    https://github.com/mitchellsimoens

  4. #3
    Sencha Premium User
    Join Date
    Nov 2010
    Location
    Chicago
    Posts
    2,425
    Answers
    20

    Default

    Quote Originally Posted by mitchellsimoens View Post
    For people new to Ext JS, showing the getter/setter right there with the config can be very helpful.

    I'm not sure what you mean by the config list barely fits. If the configs are collapsed, the getters/setters aren't in the way then? If the configs are expanded, the getters/setters only add to the documentation but getting rid of them wouldn't solve the issue of everything fitting as we add more and more text/examples would add to the height of things.
    The problem is that these getter and setter methods listed under the config name take a lot of space.

    As I said, if I maximize the panel documentation page on a 34" monitor and then mouse over configs, the popup barely fits on the page. Sure, you can scroll, but these links need not be present.

    I agree that knowing that the config has a getter or setter is helpful, but the existence these methods should be indicated either as label next to the "bind" label or in a tooltip.

    I rarely click these links, so they don't need to be clickable.

    The are are 137 config listed in the popup and well over 200 getter and setter methods.

    The configs would occupy a lot less space and therefore less scrolling would be required if the each getter or setter was not listed on a separate line.

  5. #4
    Sencha Premium User
    Join Date
    Nov 2010
    Location
    Chicago
    Posts
    2,425
    Answers
    20

    Default

    As an example, vertical space could be saved by replacing getter and setter methods with labels.

    Another idea is to indicate the existence of these methods in a tooltip.

    Code:
    autoDestroy  getAutoDestory
      setAutoDestroy
    autoSize
      getAutoSize
      setAutoSize
    
    
    autoDestroy BIND SET GET
    autoSize BIND SET GET

  6. #5
    Sencha Premium User
    Join Date
    Nov 2010
    Location
    Chicago
    Posts
    2,425
    Answers
    20

    Default

    The other thing that I noticed is that the documentation of the getter and setter methods states the obvious.

    Here's the defaultToolsWeight doc. It's kind of obvious what these methods are supposed to do. I'm not sure if there's a need to document it.

    One method sets the config and the other method gets the config.




  7. #6
    Sencha User slemmon's Avatar
    Join Date
    Mar 2009
    Location
    Boise, ID
    Posts
    6,165
    Answers
    505

    Default

    Hi,

    We've got a feature request internally for getter / setter filtering at some stage. We'll also consider badges for undocumented (auto-generated) setter / getter documentation and leave the current view or something like it for getter / setter documentation that has been expanded beyond the basic "gets a thing" and "sets a thing".

    Thanks again for the feedback!

Similar Threads

  1. Replies: 9
    Last Post: 22 Sep 2016, 12:43 PM
  2. Override getter and not setter
    By dersgniw in forum Ext 5: Q&A
    Replies: 4
    Last Post: 6 Apr 2016, 6:39 AM
  3. getter & setter
    By cylontoaster in forum Ext: Discussion
    Replies: 2
    Last Post: 13 Jul 2011, 6:36 AM
  4. API DOCS - Configs Option List is not complete ?
    By NeoLike in forum Ext: Discussion
    Replies: 0
    Last Post: 1 May 2011, 12:09 AM
  5. Convenience methods for creating Classes and wrapping App configs
    By dnalot in forum Ext 2.x: User Extensions and Plugins
    Replies: 5
    Last Post: 1 Jul 2008, 12:27 AM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •