Eclipse Community Forums: Eclipse Platform » How to set a preference page at first place ?

Help

Home

Home » Eclipse Projects » Eclipse Platform » How to set a preference page at first place ?

Show: Today's Messages :: Show Polls :: Message Navigator

How to set a preference page at first place ? [message #506898]

Mon, 11 January 2010 10:00

Olivier Thierry

Messages: 11
Registered: January 2010
Location: Nantes, France

Junior Member

Hi,

I added preference pages in a Eclipse RCP application using org.eclipse.ui.preferencePages extension point. These pages are sorted on alphabet order. But I want a specific page to be at the first place, the way it is done for example for General preference page in Eclipse ? How could I do that ?

Thanks in advance,

Olivier

Report message to a moderator

Re: How to set a preference page at first place ? [message #507095 is a reply to message #506898]

Tue, 12 January 2010 07:26

Prakash G.R.

Messages: 621
Registered: July 2009

Senior Member

On 11/01/10 3:30 PM, olivier.thierry@gmail.com wrote:
> Hi,
>
> I added preference pages in a Eclipse RCP application using
> org.eclipse.ui.preferencePages extension point. These pages are sorted
> on alphabet order. But I want a specific page to be at the first place,
> the way it is done for example for General preference page in Eclipse ?
> How could I do that ?
>
> Thanks in advance,
>
> Olivier

In your WorkbenchAdvisor, override the getComparatorFor() method.

- Prakash
Platform UI Team, IBM

Blog <http://blog.eclipse-tips.com>
Twitter <http://www.twitter.com/Eclipse_Tips>

Report message to a moderator

Re: How to set a preference page at first place ? [message #507659 is a reply to message #506898]

Thu, 14 January 2010 09:51

Catalin Gerea

Messages: 89
Registered: July 2009
Location: Bucharest, Romania

Member

Only for one page to be the first one -> override in your WorkbenchAdvisor the getMainPreferencePageId() method.

But for more control of the order of the pages overriding the getComparatorFor() method suggested above is recommended.

Time is what you make of it.

Report message to a moderator

Re: How to set a preference page at first place ? [message #508581 is a reply to message #506898]

Tue, 19 January 2010 14:24

Olivier Thierry

Messages: 11
Registered: January 2010
Location: Nantes, France

Junior Member

The getMainPreferencePageId() method is exactly what I needed. Thanks a lot for your help !

Report message to a moderator

Re: How to set a preference page at first place ? [message #519961 is a reply to message #506898]

Wed, 10 March 2010 16:20

Olivier Thierry

Messages: 11
Registered: January 2010
Location: Nantes, France

Junior Member

Finally I had more complex sorts to do so I needed to override getComparatorFor method in WorkbenchAdvisor. I desperately tried to find an example on the web, with no success. So here is a small and easy example.

I overrode the getComparatorFor method in my workbench advisor class. I needed to sort preference pages so I use a specific comparator only for "preferences" contribution types.

public ContributionComparator getComparatorFor(String contributionType) {
	if (contributionType.equals(IContributionService.TYPE_PREFERENCE)) {
		return new PreferencesComparator();
	}
	else {
		return super.getComparatorFor(contributionType);
	}
}

Then I wrote the following PreferencesComparator class. It overrides the category method to set the right value for some preference pages to display in the right order :the preference nodes with the lowest category are displayed first.

public class PreferencesComparator extends ContributionComparator {

	public int category(IComparableContribution c) {
		if (c instanceof WorkbenchPreferenceNode) {
			String id = ((WorkbenchPreferenceNode) c).getId();
			if (PlanTransportTourPreferencePage.ID.equals(id)) {
				return 1;
			}
			else if (PlanTransportSequencePreferencePage.ID.equals(id)) {
				return 2;
			}
			else if (PlanTransportPositionPreferencePage.ID.equals(id)) {
				return 3;
			}
			else {
				return super.category(c);
			}
		}
		else {
			return super.category(c);
		}
	}
}

Not sure it is a state of the art example, but I hope it will help.

Regards,

Olivier

Report message to a moderator