Home > Articles > Programming > Java

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

Like this article? We recommend

Tip of the Day

Applications often present Tip of the Day dialog boxes that help users to learn the application’s features. It’s typical for the dialog box to appear automatically the first time the application starts running, to appear automatically on subsequent application startups (optional, based on user preference), and to appear manually when chosen by the user.

SwingX supports Tip of the Day dialog boxes through its org.jdesktop.swingx.JXTipOfTheDay class. Because this class subclasses org.jdesktop.swingx.JXPanel (which enhances javax.swing.JPanel with support for translucency), JXTipOfTheDay can be used as a pane in some other dialog box. For this article, however, I’ll focus only on the dialog box usage.

The JXTipOfTheDay class describes a component with tip data specified by a model. This model is an instance of classes that implement the org.jdesktop.swingx.tips.TipOfTheDayModel interface, which specifies a collection of tips, and the nested TipOfTheDayModel$Tip interface, which describes one tip.

TipOfTheDayModel’s public int getTipCount() method returns the number of tips managed by the model; its TipOfTheDayModel.Tip getTipAt(int index) method returns the Tip at index. Tip’s public String getTipName() method returns the tip’s name; its public Object getTip() method returns the tip as a string, a component, or an icon.

Although you could implement the TipOfTheDayModel and TipOfTheDayModel$Tip interfaces in your own model class(es), SwingX provides the org.jdesktop.swingx.tips.DefaultTipOfTheDayModel and org.jdesktop.swingx.tips.DefaultTip classes that implement these interfaces for you, making it possible to construct a model conveniently:

TipOfTheDayModel.Tip tip1;
tip1 = new DefaultTip ("Tip 1",
      "<html>You can <strong>embed</strong> various " +
      "<em>HTML</em> tags in tips.");

TipOfTheDayModel.Tip tip2;
tip2 = new DefaultTip ("Tip 2",
      "JXTipOfTheDay provides methods that let you " +
      "programmatically navigate tips when you use " +
      "JXTipOfTheDay as a pane.");

java.util.List<TipOfTheDayModel.Tip> tips =
 java.util.Arrays.asList (tip1, tip2);
DefaultTipOfTheDayModel model = new DefaultTipOfTheDayModel (tips);

After creating the model, you’re ready to create a JXTipOfTheDay component. Accomplish this task by passing the model to the public JXTipOfTheDay(TipOfTheDayModel model) constructor. For those situations in which you first create the component and then the model, call public JXTipOfTheDay() followed by JXTipOfTheDay’s public void setModel(TipOfTheDayModel model) method:

// Create JXTipOfTheDay component based on previous model.

// Option 1.

JXTipOfTheDay totd = new JXTipOfTheDay (model);

// Option 2.

JXTipOfTheDay totd = new JXTipOfTheDay ();
totd.setModel (model);

JXTipOfTheDay includes several showDialog() methods that present this component as a dialog box. The simplest of these methods is public void showDialog(Component parent). Call this method with a parent window reference, as in totd.showDialog (frame);. The resulting modal dialog box is shown in Figure 4.

Figure 4

Figure 4 The Tip of the Day dialog box presents buttons for selecting previous/next tips.

Instead of using DefaultTipOfTheDayModel and DefaultTip to programmatically build a model, you can let SwingX create the model for you. Begin by storing your tips in persistent storage, with this format:

tip.x.description=y

where x is a 1-based integer and y is tip text. You can optionally precede this line with tip.x.name=z, where z names the tip:

tip.1.description=Buy low, sell high
tip.2.name=Java tip
tip.2.description=Java’s original name was Oak.

Continue by streaming this formatted storage into a java.util.Properties object. If streaming is successful, call org.jdesktop.swingx.tips.TipLoader’s public static TipOfTheDayModel load(Properties props) method to load props’ contents into a new model:

Properties tips = new Properties ();

FileInputStream fis = null;

try
{
 fis = new FileInputStream ("tips.properties");

 tips.load (fis);

 TipOfTheDayModel model = TipLoader.load (tips);

 JXTipOfTheDay totd = new JXTipOfTheDay (model);

 totd.showDialog (frame);
}
catch (IOException e)
{
 JOptionPane.showMessageDialog (frame, e.getMessage ());
}

Users often want to prevent the Tip of the Day dialog box from appearing at application startup. Accomplish this task by having the application check its persistent storage to determine whether the dialog box should appear. If shown, have the dialog box present a check box (see Figure 5) that the user toggles to prevent future dialog box activation. Save this choice to persistent storage when the dialog box closes.

Figure 5

Figure 5 Clear the check box to prevent future dialog box activation.

JXTipOfTheDay provides two ways to prevent the Tip of the Day dialog box from appearing. The first way involves its public boolean showDialog(Component parent, Preferences showOnStartupPref) method and Java’s Preferences API. The second way involves its public boolean showDialog(Component parent, JXTipOfTheDay.ShowOnStartupChoice choice) method.

For brevity, I ignore the former showDialog() method. The latter showDialog() method calls ShowOnStartupChoice’s public boolean isShowingOnStartup() method before showing the dialog box; the dialog box is not shown if false returns. When the dialog box closes, it calls void setShowingOnStartup(boolean showOnStartup) to save the check box value to persistent storage:

totd.showDialog (frame, new JXTipOfTheDay.ShowOnStartupChoice ()
      {
       public boolean isShowingOnStartup ()
       {
        // Obtain value from persistent storage.
        // Here we assume that we always want to
        // show tips at startup.

        return true;
       }

       public void setShowingOnStartup (boolean x)
       {
        // Save user choice value to persistent
        // storage. Here we just output the value
        // for simplicity.

        if (x)
         System.out.println ("User wants tips");
        else
         System.out.println ("No tips");
       }
      });

The user will probably grow frustrated with an application that always presents the same tip at startup. This problem can be solved by retrieving (from persistent storage) the index of the next tip to present at startup, by calculating the next tip index in the setShowingOnStartup() method, and (in the same method) by saving this index to persistent storage.

JXTipOfTheDay provides a public void setCurrentTip(int index) method that causes the tip at the 0-based index to be displayed, and a public int getCurrentTip() method that returns the 0-based index of the displayed tip. To advance to the next tip, you need to know the total number of tips, which TipOfTheDayModel’s getTipCount() method provides:

final JXTipOfTheDay totd = new JXTipOfTheDay (model);
totd.setCurrentTip (0); // Assume value read from persistent storage.

totd.showDialog (frame, new JXTipOfTheDay.ShowOnStartupChoice ()
      {
       public boolean isShowingOnStartup ()
       {
        // Obtain value from persistent storage.
        // Here we assume that we always want to
        // show tips at startup.

        return true;
       }

       public void setShowingOnStartup (boolean x)
       {
        // Save user choice value to persistent
        // storage. Here we just output the value
        // for simplicity.

        if (x)
         System.out.println ("User wants tips");
        else
         System.out.println ("No tips");

        // Presumably, we also save the index of
        // the next tip to display at startup.
        // Here we just output this index.

        int ct = totd.getCurrentTip ();

        int nt = totd.getModel ().getTipCount ();

        if (++ct == nt)
         ct = 0;

        System.out.println ("Future tip is " + ct);
       }
      });

Earlier, I mentioned that a tip could be implemented as a string, a component, or an icon. Although I used DefaultTip’s public DefaultTip(String name, Object tip) constructor to store string-based tips, I could just as easily have stored icons or components as tips. For additional homework, modify the TOTDDemo application to store an icon-based tip.

  • + 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