\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{NeonKnightOA} \pdfinfo{ /Title (java-swing-gui.pdf) /Creator (Cheatography) /Author (NeonKnightOA) /Subject (Java Swing/GUI Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{A35656} \definecolor{LightBackground}{HTML}{F9F4F4} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Java Swing/GUI Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{NeonKnightOA} via \textcolor{DarkBackground}{\uline{cheatography.com/24399/cs/6049/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}NeonKnightOA \\ \uline{cheatography.com/neonknightoa} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 11th November, 2015.\\ Updated 12th May, 2016.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{2} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Cheat Sheet based on:}} \tn \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{{\bf{Swing/GUI Cheat Sheet at Williams College}} \newline % Row Count 1 (+ 1) \seqsplit{http://eventfuljava.cs.williams.edu/s04/handouts/SwingGUICheatSheet.html}% Row Count 3 (+ 2) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Displaying a Swing component}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Construct and initialize the component.} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`button = new JButton ("ButtonLabel");`} \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Add it to the content pane of the window or to a JPanel that is added to the display.} \tn % Row Count 4 (+ 2) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`getContentPane().add (button);`} \tn % Row Count 5 (+ 1) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Import javax.swing.{\emph{ and sometimes also java.awt.}} at the beginning of the class creating the components.} \tn % Row Count 8 (+ 3) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`import javax.swing.{\emph{; import java.awt.}}`} \tn % Row Count 9 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Getting events from GUI component}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Declare that the class handling the event implements the appropriate listener interface.} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`implements ActionListener`} \tn % Row Count 3 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Define the method that the listener interface requires.} \tn % Row Count 5 (+ 2) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`public void actionPerformed (ActionEvent event)`} \tn % Row Count 6 (+ 1) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Add a listener appropriate for the component to the component.} \tn % Row Count 8 (+ 2) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{\seqsplit{`button.addActionListener} (this);`} \tn % Row Count 9 (+ 1) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Import java.awt.event.{\emph{ (and occasionally javax.swing.event.}}) at the beginning of the class that is the listener.} \tn % Row Count 12 (+ 3) % Row 7 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`import javax.swing.{\emph{; import java.awt.}}`} \tn % Row Count 13 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Finding out which component sent the event}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{When the listener method is called, you can find out which component sent the event by calling getSource() on the event:} \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`public void actionPerformed (ActionEvent event) \{\{\{nl\}\}~~Object theButton = event.getSource();\{\{nl\}\}~~if (theButton == framedCircleButton) \{\{\{nl\}\}~~~~// Create a framed circle\{\{nl\}\}~~\}\{\{nl\}\}\}`} \tn % Row Count 8 (+ 5) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{If a method returns a String, remember to compare the result using the equals method, not ==:} \tn % Row Count 10 (+ 2) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{\seqsplit{`aMenu.getSelectedItem().equals} ("A value");`} \tn % Row Count 11 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4.08 cm} x{3.92 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Containers}} \tn % Row 0 \SetRowColor{LightBackground} JPanel constructor: & `new JPanel ()` \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} Define the type of layout: & `void setLayout (LayoutManager lm)` \tn % Row Count 3 (+ 2) % Row 2 \SetRowColor{LightBackground} Add an object to a container:\{\{nl\}\}(FlowLayout or GridLayout) & `void add (Component c)` \tn % Row Count 7 (+ 4) % Row 3 \SetRowColor{white} Add an object to a container:\{\{nl\}\}(BorderLayout) & `void add (Component c, int position)` \tn % Row Count 10 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{Both JPanel and the object obtained by sending getContentPane() to a WindowController object are containers (and have type Container). These methods are available for all containers.\{\{nl\}\}For BorderLayouts, position may be either `BorderLayout.NORTH`, `BorderLayout.SOUTH`, `BorderLayout.EAST`, `BorderLayout.WEST`, or `BorderLayout.CENTER`.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.04 cm} x{4.96 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Layout Managers}} \tn % Row 0 \SetRowColor{LightBackground} BorderLayout constructor: & `new BorderLayout ()` \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} FlowLayout constructor: & `new FlowLayout ()` \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} GridLayout constructor: & `new GridLayout (int rows, int cols)\{\{nl\}\}new GridLayout (int rows, int cols,\{\{nl\}\}~~int colSpacing, int rowSpacing)` \tn % Row Count 10 (+ 6) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{BorderLayout is the default layout for WindowController, whereas FlowLayout is default for JPanel.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{GUI Components - General}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{The following methods can be applied to any Component:} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`void setFont (Font f)\{\{nl\}\}void setForeground (Color c)\{\{nl\}\}void setBackground (Color c)`} \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{To construct a font use:} \tn % Row Count 5 (+ 1) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`new Font (String name, int style, int size)`} \tn % Row Count 6 (+ 1) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Style can be one of the following:} \tn % Row Count 7 (+ 1) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`Font.BOLD\{\{nl\}\}Font.ITALIC\{\{nl\}\}Font.PLAIN\{\{nl\}\}Font.BOLD+Font.ITALIC`} \tn % Row Count 9 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{2.64 cm} x{5.36 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{GUI Components - JButton}} \tn % Row 0 \SetRowColor{LightBackground} Constructor: & `new JButton (String s)` \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} General Methods: & `String getText ( )\{\{nl\}\}void setText (String s)` \tn % Row Count 3 (+ 2) % Row 2 \SetRowColor{LightBackground} Listener Interface: & `ActionListener` \tn % Row Count 5 (+ 2) % Row 3 \SetRowColor{white} Adding the listener: & `void addActionListener (ActionListener al)` \tn % Row Count 7 (+ 2) % Row 4 \SetRowColor{LightBackground} Listening Method: & `void actionPerformed (ActionEvent e)` \tn % Row Count 9 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.52 cm} x{4.48 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{GUI Components - JComboBox}} \tn % Row 0 \SetRowColor{LightBackground} Constructor and Initialization: & `new JComboBox ( )\{\{nl\}\}void addItem (Object item)` \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} General Methods: & `Object getSelectedItem ( )\{\{nl\}\}String text=(String)menu.getSelectedItem();\{\{nl\}\}int getSelectedIndex ( )` \tn % Row Count 8 (+ 5) % Row 2 \SetRowColor{LightBackground} Listener Interface: & `ItemListener`\{\{nl\}\}`ActionListener` \tn % Row Count 10 (+ 2) % Row 3 \SetRowColor{white} Adding the listener: & `void addItemListener (ItemListener il)`\{\{nl\}\}`void addActionListener (ActionListener al)` \tn % Row Count 15 (+ 5) % Row 4 \SetRowColor{LightBackground} Listening Method: & `void itemStateChanged (ItemEvent e)`\{\{nl\}\}`void actionPerformed (ActionEvent e)` \tn % Row Count 19 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{{\bf{About methods:}} \newline `getSelectedItem ( )` returns the selected item\{\{nl\}\}`(String) menu.getSelectedItem ( );` is a typecast which treats the above returned value as a String\{\{nl\}\}`int getSelectedIndex ( )` returns the index of the selected item. \newline {\bf{About the listeners:}} \newline This component can hear the user making a menu selection dependong on the chosen interface. Be consistent in your choice of listener interface, adding method, and listening method.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{2.56 cm} x{5.44 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{GUI Components - JLabel}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{Constructors:} & `new JLabel (String s)\{\{nl\}\}new JLabel (String s, int align)` \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} General Methods: & `void setText (String s)\{\{nl\}\}String getText ( )` \tn % Row Count 5 (+ 2) % Row 2 \SetRowColor{LightBackground} Listener Interface: & No listeners available. \tn % Row Count 7 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{align can be either `JLabel.RIGHT`, `JLabel.LEFT` or `JLabel.CENTER`.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{2.64 cm} x{5.36 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{GUI Components - JSlider}} \tn % Row 0 \SetRowColor{LightBackground} Constructor: & `new JSlider (int orientation, int minimum,\{\{nl\}\}~~int maximum, int initialValue)` \tn % Row Count 4 (+ 4) % Row 1 \SetRowColor{white} General Methods: & `void setValue (int newVal)`\{\{nl\}\}`int getValue ( )` \tn % Row Count 6 (+ 2) % Row 2 \SetRowColor{LightBackground} Listener Interface: & `ChangeListener` \tn % Row Count 8 (+ 2) % Row 3 \SetRowColor{white} Adding the Listener: & `addChangeListener (ChangeListener al)` \tn % Row Count 10 (+ 2) % Row 4 \SetRowColor{LightBackground} Listening Method: & `void stateChanged (ChangeEvent e)` \tn % Row Count 12 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{orientation can be either `JSlider.HORIZONTAL` or `JSlider.VERTICAL`.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{2.64 cm} x{5.36 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{GUI Components - JTextField}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{Constructors:} & `new JTextField (String s)` \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} General Methods: & `void setText (String s)`\{\{nl\}\}`String getText ( )` \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} Listener Interface: & `ActionListener` \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} Adding the Listener: & `addActionListener (ActionListener al)` \tn % Row Count 8 (+ 2) % Row 4 \SetRowColor{LightBackground} Listening Method: & `void actionPerformed (ActionEvent e)` \tn % Row Count 10 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}