Let me explain.
I wanted to show the full text for each of the settings for MongoOptions.
Take the
autoConnectRetry.shortDescription property for example.
autoConnectRetry.shortDescription=If true, the driver will keep trying to connect to the same server in case that the socket cannot be established. There is maximum amount of time to keep retrying, which is 15s by default. This can be useful to avoid some exceptions being thrown when a server is down temporarily by blocking the operations. It also can be useful to smooth the transition to a new master (so that a new master is elected within the retry time). Note that when using this flag: - for a replica set, the driver will trying to connect to the old master for that time, instead of failing over to the new one right away - this does not prevent exception from being thrown in read/write operations on the socket, which must be handled by application Even if this flag is false, the driver already has mechanisms to automatically recreate broken connections and retry the read operations. Default is false.
Now this may be seen as being overly verbose. Fair enough, but I wanted to show all of this text so that users don't keep having to refer to the API docs.
The problem is, because there is so much text on a single line, it extends off both ends of the screen and causes unwanted side effects when multiple virtual desktops are in use.
No problem I thought, as I cast my mind back to my Swing development days. I'll just wrap the text in html tags and create a mutliline tooltip.
autoConnectRetry.shortDescription=<html><b>autoConnectRetry</b><br><br>If true, the driver will keep trying to connect to the same server in case that the socket cannot be established.<br>There is maximum amount of time to keep retrying, which is 15s by default.<br>This can be useful to avoid some exceptions being thrown when a server is down temporarily by blocking the operations.<br>It also can be useful to smooth the transition to a new master (so that a new master is elected within the retry <br>Note that when using this flag: - for a replica set, the driver will trying to connect to the old master for that time, instead of failing over to the new one right away - this does not prevent exception from being thrown in read/write operations on the socket, which must be handled by application Even if this flag is false, the driver already has mechanisms to automatically recreate broken connections and retry the read <operations. <br><br>Default is false.</html>
Oh dear. It seems it isn't going to be that easy. The tooltip now simple displays the html tags.
Time to don my deerstalker and get out the magnifying glass. Let's work backwards.
I'm extending BeanInfoSupport and as such I'm depending on GenericTestBeanCustomizer to render the GUI. Let's look to see what is happening during the rendering process.
core\org\apache\jmeter\testbeans\gui\GenericTestBeanCustomizer.java(597)
text = propertyToolTipMessage.format(new Object[] { desc.getName(), desc.getShortDescription() });
OK. So we're passing the name and short description to the MessageFormat instance.
If we scroll up a bit we'll see the pattern that is being applied to this MessageFormat.
core\org\apache\jmeter\testbeans\gui\GenericTestBeanCustomizer.java(283)
propertyToolTipMessage = new MessageFormat(JMeterUtils.getResString("property_tool_tip")); //$NON-NLS-1$
Not quite. We have a little more work to do here. JMeterUtils is being used to fetch resources. Let's have a quick peek in there.
core\org\apache\jmeter\util\JMeterUtils.java(371)
ResourceBundle resBund = ResourceBundle.getBundle("org.apache.jmeter.resources.messages", loc); // $NON-NLS-1$
OK. We're finally there.
core\org\apache\jmeter\resources\messages.properties(696)
property_tool_tip={0}\: {1}
Let's update this to handle html. I don't want it to break anything else, so I'm going to apply the minimum I can get away with.
core\org\apache\jmeter\resources\messages.properties(696)
property_tool_tip=<html><b>{0}</b><br><br>{1}</html>
OK. I told a teenie weenie lie; I didn't need to add the bold tag and the two new lines, but I couldn't help it. Now the properties file looks like this:
autoConnectRetry.shortDescription=If true, the driver will keep trying to connect to the same server in case that the socket cannot be established.<br>There is maximum amount of time to keep retrying, which is 15s by default.<br>This can be useful to avoid some exceptions being thrown when a server is down temporarily by blocking the operations.<br>It also can be useful to smooth the transition to a new master (so that a new master is elected within the retry <br>Note that when using this flag: - for a replica set, the driver will trying to connect to the old master for that time, instead of failing over to the new one right away - this does not prevent exception from being thrown in read/write operations on the socket, which must be handled by application Even if this flag is false, the driver already has mechanisms to automatically recreate broken connections and retry the read <operations. <br><br>Default is false.
I've removed the opening and closing html tags, along with the bolding of the property name and the two new lines, as they are all now present in the format pattern which will be applied to all tooltips across the application. All we need to do when we want any markup within tooltips is simply add it to the property value and it will automagically be rendered. If you don't want markup, then don't add any.
This looks so much better and has the added benefit of addressing the unwanted side effects when using multiple virtual desktops.
I'd imagine this isn't the best way to implement this, but maybe it is; I didn't spend much time on this and I wouldn't be surprised if there is a well documented/clever-er way of achieving the same result without having to hack a global message format pattern.
If you don't like the bold and new lines, then the change to the pattern should be as follows:
core\org\apache\jmeter\resources\messages.properties(696)
property_tool_tip=<html>{0}\: {1}</html>
No comments:
Post a Comment