Eclipse RCP Tutorial: How to Add a Progress Bar

 

This tutorial is about eclipse Job and it consists two parts. The first part introduces how to make a progress bar by using a simple example. The second part briefly illustrates Eclipse Job for background processing.

1. A Simple Example of Progress Bar in Eclipse

Suppose you have a working RCP application with a sample "Hello World" menu and corresponding action. (This can be done in no time by using eclipse extension wizard)

To report progress of some executable task, the following classes are required:

1. org.eclipse.core.runtime.jobs.Job
(Jobs are units of runnable work that can be scheduled to be run with the job manager. Once a job has completed, it can be scheduled to run again)
2. org.eclipse.core.runtime.IProgressMonitor

To have a taste of how a progress bar looks like, simply replace the run method with the following code. It does not do a real job, but only mimic a real task.

	public void run(IAction action) {
		Job job = new Job("Test Job") {
			@Override
			protected IStatus run(IProgressMonitor monitor) {
				// Set total number of work units
				monitor.beginTask("start task", 100);
 
				for (int i = 0; i < 10; i++) {
					try {
						Thread.sleep(1000);
						monitor.subTask("doing " + i);
						// Report that 10 units are done
						monitor.worked(10);
					} catch (InterruptedException e1) {
						e1.printStackTrace();
					}
				}
				return Status.OK_STATUS;
			}
		};
 
		job.schedule();
	}

Add the following statement to preWindowOpen method of ApplicationWorkbenchWindowAdvisor class.

public class ApplicationWorkbenchWindowAdvisor extends WorkbenchWindowAdvisor {
 
	public ApplicationWorkbenchWindowAdvisor(IWorkbenchWindowConfigurer configurer) {
		super(configurer);
	}
 
	public ActionBarAdvisor createActionBarAdvisor(
			IActionBarConfigurer configurer) {
		return new ApplicationActionBarAdvisor(configurer);
	}
 
	public void preWindowOpen() {
		IWorkbenchWindowConfigurer configurer = getWindowConfigurer();
		configurer.setInitialSize(new Point(400, 300));
		configurer.setShowCoolBar(false);
		configurer.setShowStatusLine(false);
		configurer.setTitle("RCP Application");
 
		configurer.setShowProgressIndicator(true);
	}
}

2. Enable Background Processing

Suppose you have a Rich Client Application with a view and a button. When the button is clicked, a time-consuming work will be started.

eclipse-one-thread.png

 

If this expensive job is implemented in a straightforward way, i.e. implemented in main thread, then the view of the application will not be responsive. If you click other menu or button, no one will respond. This could be annoying for a lot of users and make then believe they need to kill the process.

public void createPartControl(Composite parent) {
		Composite top = new Composite(parent, SWT.NONE);
 
		// setup the layout of top to be GridLayout.
		GridLayout layout = new GridLayout();
		layout.marginHeight = 0;
		layout.marginWidth = 0;
 
		top.setLayout(layout);
		Button button = new Button(top, SWT.PUSH);
 
		button.setText("test button");
 
		Listener listener = new Listener() {
		      public void handleEvent(Event event) { //expensive job below
		    	  for (int i = 0; i < 10; i++) {
		  			try {		  				
		  				Thread.sleep(2000);
		  				System.out.println(i);
		  			} catch (InterruptedException e) {
		  				e.printStackTrace();
		  			}
		    	  }
		      }
		    };
 
		button.addListener(SWT.Selection, listener); 
	}

One possible solution is creating multiple threads and then synchronize each other. This should work but there is an easy way which is provided by Eclipse Platform.

경축! 아무것도 안하여 에스천사게임즈가 새로운 모습으로 재오픈 하였습니다.
어린이용이며, 설치가 필요없는 브라우저 게임입니다.
https://s1004games.com

Under Eclipse, we can put time-consuming work into a Job. The Job class, provided in the org.eclipse.core.runtime plug-in, allows clients to easily execute code in a separate thread. In addition, a progress monitor bar can be added easily.

 Listener listener = new Listener() {
		      public void handleEvent(Event event) {
 
		    	  Job job = new Job("test") {
		  			@Override
		  			protected IStatus run(IProgressMonitor monitor) {
		  				monitor.beginTask("start task", 100);
 
		  				//time consuming work here
		  				doExpensiveWork(monitor);
		  				//sync with UI				
		  				syncWithUI();
 
		  				return Status.OK_STATUS;
		  			}
 
		  		};
		  		job.setUser(true);
		  		job.schedule();  	  
		      }
		    };

doExpensiveWork and syncWithUI are defined as the following:

	private void doExpensiveWork(IProgressMonitor monitor) {
		// mimic a long time job here
		for (int i = 0; i < 10; i++) {
			try {
				//give a progress bar to indicate progress
				monitor.worked(10);
 
				Thread.sleep(2000);
				System.out.println("step: " + i);
			} catch (InterruptedException e) {
				e.printStackTrace();
			}
		}
	}
 
	private void syncWithUI() {
		Display.getDefault().asyncExec(new Runnable() {
			public void run() {
				MessageDialog.openInformation(getSite().getShell(), "message",
						"completed!");
			}
		});
	}

asyncExec allows the calling thread to be asynchronous with the calling thread. The caller of this method continues to run in parallel, and is not notified when the runnable has completed.

Instead we can use syncExec, in which case the thread which calls this method is suspended until the runnable completes.

The difference is apparent in this demo. syncExec has to wait user to click "OK" button to complete, while asyncExec does not.

Reference

On the Job

 

[출처] http://www.programcreek.com/2012/01/eclipse-rcp-tutorial-how-to-add-a-progress-bar/

 

 

 

 

본 웹사이트는 광고를 포함하고 있습니다.
광고 클릭에서 발생하는 수익금은 모두 웹사이트 서버의 유지 및 관리, 그리고 기술 콘텐츠 향상을 위해 쓰여집니다.
번호 제목 글쓴이 날짜 조회 수
49 JAVA SWT TEST 자료 졸리운_곰 2015.05.07 545
48 [SWING] 분석에 도전해볼만한 오픈소스 WebHarvest Java WebCrawler GUI file 졸리운_곰 2015.05.20 517
47 [SWT] MessageBox Example file 졸리운_곰 2015.08.16 380
46 SWT JAVA 동적으로 컨트롤을 추가하는 다이얼로그 졸리운_곰 2015.04.27 271
45 Demonstrates TreeViewer file 졸리운_곰 2015.08.05 258
44 JAVA SWT XML EDITOR sample : 자바 SWT XML 에디터 예제 file 졸리운_곰 2015.05.12 241
43 SWT 2D Chart: Flowchart : 2D « SWT JFace Eclipse « Java file 졸리운_곰 2015.07.28 232
42 SWT 스크롤 ScrolledComposite file 졸리운_곰 2015.05.03 230
41 [SWT, Java], Button by Image, 이미지로 버튼 생성 졸리운_곰 2015.08.22 204
40 SWT Control in One Example file 졸리운_곰 2015.08.10 193
39 SWT Tree With Multi columns file 졸리운_곰 2015.08.06 152
38 JAVA SWT 대화상자 예제 : 동적으로 컨트롤을 추가하고 삭제하는 예제 졸리운_곰 2015.05.11 140
37 SWT JAVA 동적으로 컨트롤을 추가하는 다이얼로그2 file 졸리운_곰 2015.04.27 139
36 A simple Java console: 졸리운_곰 2015.04.24 131
35 Use of Java2D on SWT or Draw2D graphical context : 2D « SWT JFace Eclipse « Java file 졸리운_곰 2015.07.28 130
34 Java SWT 소개 file 졸리운_곰 2015.03.30 127
33 JAVA SWT LINUX (Ubuntu) 에서 SWT Browser Control 사용시 졸리운_곰 2015.05.10 120
» Eclipse RCP Tutorial: How to Add a Progress Bar file 졸리운_곰 2015.11.07 119
31 Building and delivering a table editor with SWT/JFace file 졸리운_곰 2019.06.16 110
30 Demonstrates TreeEditor : Tree « SWT JFace Eclipse « Java file 졸리운_곰 2015.07.28 109
대표 김성준 주소 : 경기 용인 분당수지 U타워 등록번호 : 142-07-27414
통신판매업 신고 : 제2012-용인수지-0185호 출판업 신고 : 수지구청 제 123호 개인정보보호최고책임자 : 김성준 sjkim70@stechstar.com
대표전화 : 010-4589-2193 [fax] 02-6280-1294 COPYRIGHT(C) stechstar.com ALL RIGHTS RESERVED