|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jgoodies.forms.builder.ListViewBuilder
public final class ListViewBuilder
Builds list/table views from a set of mandatory and optional components: label, filter/search, list (table), list buttons, list extras, details view (or preview).
Examples:
return new ListViewBuilder() .label("&Contacts:") .listView(contactsTable) .listBar(newButton, editButton, deleteButton) .build(); return new ListViewBuilder() .border(Borders.DLU14) .labelView(contactsLabel) .filterView(contactsSearchField) .listView(contactsTable) .listBar(newButton, editButton, deleteButton, null, printButton) .detailsView(contactDetailsView) .build();
Constructor Summary | |
---|---|
ListViewBuilder()
Constructs a ListViewBuilder using the AbstractBuilder's default component factory. |
|
ListViewBuilder(ComponentFactory factory)
Constructs a ListViewBuilder using the given component factory. |
Method Summary | |
---|---|
ListViewBuilder |
border(Border border)
Sets an optional border that surrounds the list view including the label and details. |
JComponent |
build()
Lazily builds and returns the list view panel. |
ListViewBuilder |
detailsView(JComponent detailsView)
Sets an optional details view that is located under the list view. |
ListViewBuilder |
filterView(JComponent filterView)
Sets an optional view that will be placed in the upper right corner of the built list view panel. |
ListViewBuilder |
filterViewColSpec(String colSpec)
Changes the FormLayout column specification used to lay out the filter view. |
ListViewBuilder |
headerLabel(String markedText)
Creates a header label for the given marked text and sets it as label view. |
ListViewBuilder |
label(String markedText)
Creates a plain label for the given marked text and sets it as label view. |
ListViewBuilder |
labelView(JComponent labelView)
Sets the mandatory label view. |
ListViewBuilder |
listBar(JComponent... buttons)
Builds a button bar using the given buttons and sets it as list bar. |
ListViewBuilder |
listBarView(JComponent listBarView)
Sets an optional list bar - often a button bar - that will be located in the lower left corner of the list view. |
ListViewBuilder |
listExtrasView(JComponent listExtrasView)
Sets an optional view that is located in the lower right corner of the list view, aligned with the list bar. |
ListViewBuilder |
listView(JComponent listView)
Sets the given component as the the mandatory list view. |
ListViewBuilder |
listViewRowSpec(String rowSpec)
Changes the FormLayout row specification used to lay out the list view. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ListViewBuilder()
label(String)
and headerLabel(String)
.
public ListViewBuilder(ComponentFactory factory)
label(String)
and headerLabel(String)
.
factory
- the component factory used to create labels and headersMethod Detail |
---|
public ListViewBuilder border(Border border)
border
- the border to setpublic ListViewBuilder labelView(JComponent labelView)
labelView
- the component that shall label the list view,
often a bound labelpublic ListViewBuilder label(String markedText)
labelView(aComponentFactory.createLabel(markedText));
markedText
- the label's text, may contain a mnemonic markerpublic ListViewBuilder headerLabel(String markedText)
labelView(aComponentFactory.createHeaderLabel(markedText));
markedText
- the label's text, may contain a mnemonic markerpublic ListViewBuilder filterView(JComponent filterView)
filterView
- the view to be added.public ListViewBuilder filterViewColSpec(String colSpec)
"[100dlu, p]"
, which is a column where
the width is determined by the filter view's preferred width,
but a minimum width of 100dlu is ensured. The filter view won't grow
horizontally, if the container gets more space.
colSpec
- specifies the horizontal layout of the filter view
NullPointerException
- if colSpec
is null
public ListViewBuilder listView(JComponent listView)
listView
is a JTable, JList, or JTree, it is
automatically wrapped with a JScrollPane, before the scroll pane
is set as list view.
listView
- the component to be used as scrollable list view
NullPointerException
- if listView
is null
public ListViewBuilder listViewRowSpec(String rowSpec)
"fill:[100dlu, pref]:grow"
, which is a row
that is filled by the list view; the height is determined
by the list view's preferred height, but a minimum of 100dlu is ensured.
The list view grows vertically, if the container gets more vertical
space.Examples:
.listViewRowSpec("fill:100dlu"); // fixed height .listViewRowSpec("f:100dlu:g"); // fixed start height, grows .listViewRowSpec("f:p"); // no minimum height
rowSpec
- specifies the vertical layout of the list view
NullPointerException
- if rowSpec
is null
public ListViewBuilder listBarView(JComponent listBarView)
listBar(JComponent...)
instead.
listBarView
- the component to setpublic ListViewBuilder listBar(JComponent... buttons)
Equivalent to listBarView(Forms.buildButtonBar(buttons))
.
buttons
- the buttons in the list bar
NullPointerException
- if buttons
is null
IllegalArgumentException
- if no buttons are providedButtonBarBuilder.addButton(JComponent...)
public ListViewBuilder listExtrasView(JComponent listExtrasView)
listExtrasView
- the component to setpublic ListViewBuilder detailsView(JComponent detailsView)
detailsView
- the component to setpublic JComponent build()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |