Java Doc for ButtonBarBuilder.java in  » Swing-Library » jgoodies-forms » com » jgoodies » forms » builder » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Swing Library » jgoodies forms » com.jgoodies.forms.builder 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.jgoodies.forms.builder.AbstractFormBuilder
      com.jgoodies.forms.builder.PanelBuilder
         com.jgoodies.forms.builder.ButtonBarBuilder

ButtonBarBuilder
final public class ButtonBarBuilder extends PanelBuilder (Code)
A non-visual builder that assists you in building consistent button bars that comply with popular UI style guides. It utilizes the FormLayout . This class is in turn used by the com.jgoodies.forms.factories.ButtonBarFactory that provides an even higher level of abstraction for building consistent button bars.

Buttons added to the builder are either gridded or fixed and may fill their FormLayout cell or not. All gridded buttons get the same width, while fixed buttons use their own size. Gridded buttons honor the default minimum button width as specified by the current com.jgoodies.forms.util.LayoutStyle .

You can set an optional hint for narrow margin for the fixed width buttons. This is useful if you want to lay out a button bar that includes a button with a long text. For example, in a bar with 'Copy to Clipboard', 'OK', 'Cancel' you may declare the clipboard button as a fixed size button with narrow margins, OK and Cancel as gridded. Gridded buttons are marked as narrow by default. Note that some look&feels do not support the narrow margin feature, and conversely, others have only narrow margins. The JGoodies look&feels honor the setting, the Mac Aqua l&f uses narrow margins all the time.

To honor the platform's button order (left-to-right vs. right-to-left) this builder uses the leftToRightButtonOrder property. It is initialized with the current LayoutStyle's button order, which in turn is left-to-right on most platforms and right-to-left on the Mac OS X. Builder methods that create sequences of buttons (e.g. ButtonBarBuilder.addGriddedButtons(JButton[]) honor the button order. If you want to ignore the default button order, you can either add add individual buttons, or create a ButtonBarBuilder instance with the order set to left-to-right. For the latter see ButtonBarBuilder.createLeftToRightBuilder() . Also see the button order example below.

Example:
The following example builds a button bar with Help button on the left-hand side and OK, Cancel, Apply buttons on the right-hand side.

 private JPanel createHelpOKCancelApplyBar(
 JButton help, JButton ok, JButton cancel, JButton apply) {
 ButtonBarBuilder builder = new ButtonBarBuilder();
 builder.addGridded(help);
 builder.addRelatedGap();
 builder.addGlue();
 builder.addGriddedButtons(new JButton[]{ok, cancel, apply});
 return builder.getPanel();
 }
 

Button Order Example:
The following example builds three button bars where one honors the platform's button order and the other two ignore it.

 public JComponent buildPanel() {
 FormLayout layout = new FormLayout("pref");
 DefaultFormBuilder rowBuilder = new DefaultFormBuilder(layout);
 rowBuilder.setDefaultDialogBorder();
 rowBuilder.append(buildButtonSequence(new ButtonBarBuilder()));
 rowBuilder.append(buildButtonSequence(ButtonBarBuilder.createLeftToRightBuilder()));
 rowBuilder.append(buildIndividualButtons(new ButtonBarBuilder()));
 return rowBuilder.getPanel();
 }
 private Component buildButtonSequence(ButtonBarBuilder builder) {
 builder.addGriddedButtons(new JButton[] {
 new JButton("One"),
 new JButton("Two"),
 new JButton("Three")
 });
 return builder.getPanel();
 }
 private Component buildIndividualButtons(ButtonBarBuilder builder) {
 builder.addGridded(new JButton("One"));
 builder.addRelatedGap();
 builder.addGridded(new JButton("Two"));
 builder.addRelatedGap();
 builder.addGridded(new JButton("Three"));
 return builder.getPanel();
 }
 

author:
   Karsten Lentzsch
version:
   $Revision: 1.3 $
See Also:   ButtonStackBuilder
See Also:   com.jgoodies.forms.factories.ButtonBarFactory
See Also:   com.jgoodies.forms.util.LayoutStyle



Constructor Summary
public  ButtonBarBuilder()
     Constructs an instance of ButtonBarBuilder on a JPanel using a preconfigured FormLayout as layout manager.
public  ButtonBarBuilder(JPanel panel)
     Constructs an instance of ButtonBarBuilder on the given panel using a preconfigured FormLayout as layout manager.

Method Summary
public  voidaddFixed(JComponent component)
     Adds a fixed size component.
public  voidaddFixedNarrow(JComponent component)
     Adds a fixed size component with narrow margins.
public  voidaddGlue()
     Adds a glue that will be given the extra space, if this box is larger than its preferred size.
public  voidaddGridded(JComponent component)
     Adds a gridded component, i.e.
public  voidaddGriddedButtons(JButton[] buttons)
     Adds a sequence of related gridded buttons each separated by a default gap.
public  voidaddGriddedGrowing(JComponent component)
     Adds a gridded component that grows.
public  voidaddGriddedGrowingButtons(JButton[] buttons)
     Adds a sequence of gridded buttons that grow where each is separated by a default gap. Honors this builder's button order.
public  voidaddRelatedGap()
     Adds the standard gap for related components.
public  voidaddStrut(ConstantSize size)
     Adds a strut of a specified size.
public  voidaddUnrelatedGap()
     Adds the standard gap for unrelated components.
public static  ButtonBarBuildercreateLeftToRightBuilder()
     Creates and returns a ButtonBarBuilder with initialized with a left to right button order.
public  booleanisLeftToRightButtonOrder()
     Returns whether button sequences will be ordered from left to right or from right to left.
public  voidsetDefaultButtonBarGapBorder()
     Sets a default border that has a gap in the bar's north.
public  voidsetLeftToRightButtonOrder(boolean newButtonOrder)
     Sets the order for button sequences to either left to right, or right to left.


Constructor Detail
ButtonBarBuilder
public ButtonBarBuilder()(Code)
Constructs an instance of ButtonBarBuilder on a JPanel using a preconfigured FormLayout as layout manager.



ButtonBarBuilder
public ButtonBarBuilder(JPanel panel)(Code)
Constructs an instance of ButtonBarBuilder on the given panel using a preconfigured FormLayout as layout manager.
Parameters:
  panel - the layout container




Method Detail
addFixed
public void addFixed(JComponent component)(Code)
Adds a fixed size component. Unlike the gridded components, this component keeps its individual preferred dimension.
Parameters:
  component - the component to add



addFixedNarrow
public void addFixedNarrow(JComponent component)(Code)
Adds a fixed size component with narrow margins. Unlike the gridded components, this component keeps its individual preferred dimension.
Parameters:
  component - the component to add



addGlue
public void addGlue()(Code)
Adds a glue that will be given the extra space, if this box is larger than its preferred size.



addGridded
public void addGridded(JComponent component)(Code)
Adds a gridded component, i.e. a component that will get the same dimension as all other gridded components.
Parameters:
  component - the component to add



addGriddedButtons
public void addGriddedButtons(JButton[] buttons)(Code)
Adds a sequence of related gridded buttons each separated by a default gap. Honors this builder's button order. If you want to use a fixed left to right order, add individual buttons.
Parameters:
  buttons - an array of buttons to add
See Also:   LayoutStyle



addGriddedGrowing
public void addGriddedGrowing(JComponent component)(Code)
Adds a gridded component that grows. The component's initial size (before it grows) is the same as for all other gridded components.
Parameters:
  component - the component to add



addGriddedGrowingButtons
public void addGriddedGrowingButtons(JButton[] buttons)(Code)
Adds a sequence of gridded buttons that grow where each is separated by a default gap. Honors this builder's button order. If you want to use a fixed left to right order, add individual buttons.
Parameters:
  buttons - an array of buttons to add
See Also:   LayoutStyle



addRelatedGap
public void addRelatedGap()(Code)
Adds the standard gap for related components.



addStrut
public void addStrut(ConstantSize size)(Code)
Adds a strut of a specified size.
Parameters:
  size - a ConstantSize that describes the gap's size



addUnrelatedGap
public void addUnrelatedGap()(Code)
Adds the standard gap for unrelated components.



createLeftToRightBuilder
public static ButtonBarBuilder createLeftToRightBuilder()(Code)
Creates and returns a ButtonBarBuilder with initialized with a left to right button order. a button bar builder with button order set to left-to-right



isLeftToRightButtonOrder
public boolean isLeftToRightButtonOrder()(Code)
Returns whether button sequences will be ordered from left to right or from right to left. true if button sequences are ordered from left to right
since:
   1.0.3
See Also:   LayoutStyle.isLeftToRightButtonOrder



setDefaultButtonBarGapBorder
public void setDefaultButtonBarGapBorder()(Code)
Sets a default border that has a gap in the bar's north.



setLeftToRightButtonOrder
public void setLeftToRightButtonOrder(boolean newButtonOrder)(Code)
Sets the order for button sequences to either left to right, or right to left.
Parameters:
  newButtonOrder - true if button sequences shall be ordered from left to right
since:
   1.0.3
See Also:   LayoutStyle.isLeftToRightButtonOrder



Methods inherited from com.jgoodies.forms.builder.PanelBuilder
final public JLabel add(JLabel label, CellConstraints labelConstraints, Component component, CellConstraints componentConstraints)(Code)(Java Doc)
final public JLabel addLabel(String textWithMnemonic)(Code)(Java Doc)
final public JLabel addLabel(String textWithMnemonic, CellConstraints constraints)(Code)(Java Doc)
final public JLabel addLabel(String textWithMnemonic, String encodedConstraints)(Code)(Java Doc)
final public JLabel addLabel(String textWithMnemonic, CellConstraints labelConstraints, Component component, CellConstraints componentConstraints)(Code)(Java Doc)
final public JComponent addSeparator(String textWithMnemonic)(Code)(Java Doc)
final public JComponent addSeparator(String textWithMnemonic, CellConstraints constraints)(Code)(Java Doc)
final public JComponent addSeparator(String textWithMnemonic, String encodedConstraints)(Code)(Java Doc)
final public JComponent addSeparator(String textWithMnemonic, int columnSpan)(Code)(Java Doc)
final public JLabel addTitle(String textWithMnemonic)(Code)(Java Doc)
final public JLabel addTitle(String textWithMnemonic, CellConstraints constraints)(Code)(Java Doc)
final public JLabel addTitle(String textWithMnemonic, String encodedConstraints)(Code)(Java Doc)
final public ComponentFactory getComponentFactory()(Code)(Java Doc)
final public JPanel getPanel()(Code)(Java Doc)
final public void setBackground(Color background)(Code)(Java Doc)
final public void setBorder(Border border)(Code)(Java Doc)
final public void setComponentFactory(ComponentFactory newFactory)(Code)(Java Doc)
final public void setDefaultDialogBorder()(Code)(Java Doc)
final public void setOpaque(boolean b)(Code)(Java Doc)

Methods inherited from com.jgoodies.forms.builder.AbstractFormBuilder
final public Component add(Component component, CellConstraints cellConstraints)(Code)(Java Doc)
final public Component add(Component component, String encodedCellConstraints)(Code)(Java Doc)
final public Component add(Component component)(Code)(Java Doc)
final public void appendColumn(ColumnSpec columnSpec)(Code)(Java Doc)
final public void appendColumn(String encodedColumnSpec)(Code)(Java Doc)
final public void appendGlueColumn()(Code)(Java Doc)
final public void appendGlueRow()(Code)(Java Doc)
final public void appendLabelComponentsGapColumn()(Code)(Java Doc)
final public void appendParagraphGapRow()(Code)(Java Doc)
final public void appendRelatedComponentsGapColumn()(Code)(Java Doc)
final public void appendRelatedComponentsGapRow()(Code)(Java Doc)
final public void appendRow(RowSpec rowSpec)(Code)(Java Doc)
final public void appendRow(String encodedRowSpec)(Code)(Java Doc)
final public void appendUnrelatedComponentsGapColumn()(Code)(Java Doc)
final public void appendUnrelatedComponentsGapRow()(Code)(Java Doc)
final protected CellConstraints cellConstraints()(Code)(Java Doc)
final protected CellConstraints createLeftAdjustedConstraints(int columnSpan)(Code)(Java Doc)
final public int getColumn()(Code)(Java Doc)
final public int getColumnCount()(Code)(Java Doc)
final protected int getColumnIncrementSign()(Code)(Java Doc)
final public Container getContainer()(Code)(Java Doc)
final public FormLayout getLayout()(Code)(Java Doc)
protected int getLeadingColumn()(Code)(Java Doc)
final public int getRow()(Code)(Java Doc)
final public int getRowCount()(Code)(Java Doc)
final public boolean isLeftToRight()(Code)(Java Doc)
final public void nextColumn()(Code)(Java Doc)
final public void nextColumn(int columns)(Code)(Java Doc)
final public void nextLine()(Code)(Java Doc)
final public void nextLine(int lines)(Code)(Java Doc)
final public void nextRow()(Code)(Java Doc)
final public void nextRow(int rows)(Code)(Java Doc)
final public void setAlignment(CellConstraints.Alignment hAlign, CellConstraints.Alignment vAlign)(Code)(Java Doc)
final public void setBounds(int column, int row, int columnSpan, int rowSpan)(Code)(Java Doc)
final public void setColumn(int column)(Code)(Java Doc)
final public void setColumnSpan(int columnSpan)(Code)(Java Doc)
final public void setExtent(int columnSpan, int rowSpan)(Code)(Java Doc)
final public void setHAlignment(CellConstraints.Alignment alignment)(Code)(Java Doc)
final public void setLeftToRight(boolean b)(Code)(Java Doc)
final public void setOrigin(int column, int row)(Code)(Java Doc)
final public void setRow(int row)(Code)(Java Doc)
final public void setRowSpan(int rowSpan)(Code)(Java Doc)
final public void setVAlignment(CellConstraints.Alignment alignment)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.