Home > Articles > Programming > Java

  • Print
  • + Share This
Like this article? We recommend

Design the Program

We developers are often guilty of sitting down at a computer and writing a program's source code without taking time to think about the program's design. This "seat of the pants" coding without design takes substantially more time to complete than it would if some thought was first given to what the program's graphical user interface (GUI) and structure look like. Therefore, before writing any source code for our media player, we should give its design some thought.

How do we express the media player's design? We accomplish this task in two phases: First, we design the GUI. A visual indication of what the media player looks like along with an inventory of GUI components that need to be coded helps us think about a basic structure for the program. Second, we design the program's structure by writing an English language–like (or Japanese language–like, or French language–like, or Arabic language–like, and so on) description of this structure. (Because I speak and write in English, an English language–like description will have to suffice.) This description is known as pseudo-code because it shows how a program works without regard to the actual syntax of the language used to code the program. (An alternative technique for expressing program structure uses a flowchart—a graphical description of a program's structure. However, flowcharts are often cumbersome to create, and need to be changed whenever program design changes. Therefore, I won't say anything more about flowcharts.)

GUI Design

Our media player's GUI consists of a main window, a pop-up File menu, and an Open File dialog box. To begin designing this GUI, let's focus on the main window. This window will display Media Player 1.0 in its title bar, the word File in its menu bar, and a welcome message on a colored background. Figure 1 illustrates the main window.

Figure 1

The media player's main window identifies a File menu and a welcome message.

The File menu contains three menu items. The Open... menu item presents a dialog box for selecting the location and name of a media file. The Loop menu item determines whether a media file is played once (the default) or repetitively (when this menu item is checked). Finally, the Exit menu item exits the program. We can also exit by clicking the Close button, labeled with an X, in the upper-right corner of the main window. Figure 2 illustrates the File menu.

Figure 2

The File menu presents menu items for opening a media file, determining whether or not media will be played in a loop, and exiting the program.

When Open... is selected from the File menu, an Open File dialog box is displayed. Clicking the Open button opens a media file; clicking Cancel terminates the dialog box without opening a file. This dialog box appears in Figure 3.

Figure 3

The Open File dialog box gives users the ability to select the location and name of a media file to be opened and played.

In addition to the aforementioned components, a media player also contains a visual component, a control panel component, or a combination of these components. The visual component displays each frame (media image) in sequence for media files that contain images. The control panel component allows the user to pause, start, and otherwise control the playback of media. Both the visual and control panel components are created by the JMF and not our program. Although they're important to the overall media player GUI, these components are not discussed in this section—their creation and destruction is shown in the media player's source code. Furthermore, they're illustrated when we look into running the media player.

Pseudo-code Design

Now that you've seen the various components comprising our media player's GUI, you should be starting to get a "feel" for how this program will be structured. Essentially, this GUI-based program will be menu-driven. Before diving into the source code, let's write this program, using pseudo-code. Then, when we write the actual source code, we can follow this pseudo-code plan. Listing 1 presents the media player program's pseudo-code representation.

Listing 1  A pseudo-code representation of our media player

Application class: MediaPlayer
Superclass: Frame
Listeners implemented by Frame: Action, Controller, Item, Window

main:
   * Allocate memory for MediaPlayer object.
   * Call constructor to establish MediaPlayer's main window and
     implicitly create/start background AWT threads.
   * Exit main program thread.  Background AWT threads keep program
     running.

constructor:
   * Set main window title to Media Player 1.0.
   * Register window listener to respond to window closing and window
     closed events.
   * Create File menu.
   * Create Open... menu item.
   * Register MediaPlayer object as a listener for action events
     originating from Open... menu item.
   * Add Open... menu item to File menu.
   * Add a horizontal separator line to File menu.
   * Create checked Loop menu item.
   * Register MediaPlayer object as a listener for item events
     originating from Loop menu item.
   * Add Loop menu item to File menu.
   * Add a horizontal separator line to File menu.
   * Create Exit menu item.
   * Register MediaPlayer object as a listener for action events
     originating from Exit menu item.
   * Add Exit menu item to File menu.
   * Create a menu bar.
   * Add the File menu to this menu bar.
   * Establish the newly created menu bar as the main window's menu
     bar.
   * Set the main window's size to 200 by 200 pixels.
   * Show the main window.
   * Exit constructor (Background AWT threads have been created/
     started).

Action listener:

On action:
   * If the action event originates from the Exit menu item,
      * Indirectly fire a window closed event to the window listener.
      * Exit handler.
   * Create an Open File dialog box.
   * Set the Open File dialog box's current directory to the
     directory that was current when the dialog box was closed.
   * Show the Open File dialog box.  This dialog box is modal.
   * If no file was selected,
      * Exit handler.
   * Save the Open File dialog box's directory.
   * If a previous JMF player object was created,
      * Close the player represented by this object.
   * Create a media locator object that uses the file: protocol along
     with the directory and filename selected in the Open File dialog
     box, and use this object to create a JMF player object.
   * If an exception is thrown,
      * Display an appropriate error message describing the
        exception.
      * Exit handler.
   * Set main window title to filename (chosen from Open File dialog
     box).
   * Register MediaPlayer object as a listener for controller events
     originating from JMF player object.
   * Tell the JMF player object to prefetch the media content
     contained in the player's media file.
   * Exit handler.

Controller listener:

On controller closed:
   * Remove JMF player's visual component from MediaPlayer frame
     container, if visual component exists.
   * Remove JMF player's control panel component from MediaPlayer
     frame container, if control panel component exists.
   * Exit handler.

On end of media:
   * If Loop menu item checked,
      * Reset the JMF player object's start time.
      * Tell the JMF player object to start playing the media.
   * Exit handler.

On prefetch complete:
   * Tell the JMF player object to start playing the media.
   * Exit handler.

On realize complete:
   * Get the JMF player object's visual component.
   * If visual component exists, add it to the center of
     MediaPlayer's frame container.
   * Get the JMF player object's control panel component.
   * If control panel component exists, add it to the south part of
     MediaPlayer's frame container.
   * Pack all components into the main window.  This causes the size
     of the main window to be adjusted by its container's layout
     manager.
   * Exit handler.

Item listener:

On item state changed:
   * Toggle the checked status of the Loop menu item.
   * Exit handler.

Paint listener:

On paint:
   * If a media file has not been loaded,
      * Obtain the width and height of the main window.
      * Set all pixels in the main window to blue.
      * Create a DialogInput/Bold/size 16 font and establish this
        font as the main window's font.
      * Obtain the font metrics for this font.
      * Use the font metrics to calculate the width (in pixels) of a
        welcome message.
      * Change the drawing color to white.
      * Draw the welcome message in the center of the main window
        (more or less).
   * Invoke the Frame superclass's paint handler – to ensure that
     the control panel component will paint itself appropriately
     (when a media file is displayed).
   * Exit handler.

On update:
   * Call the paint handler.
   * Exit handler.

Window listener:

On window closing:
   * Indirectly fire a window closed event to the window listener.
   * Exit handler.

On window closed:
   * If JMF player object was created,
      * Close player associated with object.
   * Exit program by terminating all threads.

The first three lines of pseudo-code establish our media player's class name, the class name of its superclass, and the listeners that are implemented by the MediaPlayer class. The line prefixed main: identifies MediaPlayer's main method. Similarly, constructor: identifies the MediaPlayer constructor. The rest of the pseudo-code is broken down into five listener sections: Action listener, Controller listener, Item listener, Paint listener, and Window listener. Each listener section is subdivided into one or more "on" subsections; each "on" subsection handles a specific event under its listener category. I recommend spending some time studying this pseudo-code to learn how the media player works.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020