org.jvnet.lafwidget.tabbed
public abstract class TabPreviewPainter extends java.lang.Object
Constructor and Description |
---|
TabPreviewPainter() |
Modifier and Type | Method and Description |
---|---|
javax.swing.JFrame |
getModalOwner(javax.swing.JTabbedPane tabPane)
Returns the owner of the overview dialog of the specified tabbed pane.
|
LafConstants.TabOverviewKind |
getOverviewKind(javax.swing.JTabbedPane tabPane)
Returns the tab overview kind for the specified tabbed pane.
|
java.awt.Rectangle |
getPreviewDialogScreenBounds(javax.swing.JTabbedPane tabPane)
Returns the screen bounds of the tab preview dialog window.
|
java.awt.Dimension |
getPreviewWindowDimension(javax.swing.JTabbedPane tabPane,
int tabIndex)
Returns the dimension for the tab preview window.
|
int |
getPreviewWindowExtraDelay(javax.swing.JTabbedPane tabPane,
int tabIndex)
Returns extra delay (in milliseconds) for showing the tab preview window.
|
int |
getUpdateCycle(javax.swing.JTabbedPane tabPane)
If the result of
toUpdatePeriodically(JTabbedPane) is
true , returns the update cycle length in milliseconds. |
boolean |
hasOverviewDialog(javax.swing.JTabbedPane tabPane)
Checks whether the specified tabbed pane has an overview dialog.
|
boolean |
hasPreview(javax.swing.JTabbedPane tabPane,
int tabIndex)
Checks whether the specified tab component is previewable.
|
boolean |
hasPreviewWindow(javax.swing.JTabbedPane tabPane,
int tabIndex)
Checks whether the specified tabbed pane has a preview window for the
specified tab.
|
boolean |
isSensitiveToEvents(javax.swing.JTabbedPane tabPane,
int tabIndex)
Checks whether the specified tab component is sensitive to events.
|
void |
previewTab(javax.swing.JTabbedPane tabPane,
int tabIndex,
java.awt.Graphics g,
int x,
int y,
int w,
int h)
Draws a tab preview on the specified graphics.
|
boolean |
toDisposeOverviewOnFocusLoss()
Returns indication whether the tab overview dialog should be
automatically disposed when it loses focus.
|
boolean |
toUpdatePeriodically(javax.swing.JTabbedPane tabPane)
Returns indication whether the thumbnail preview should be updated
periodically.
|
public void previewTab(javax.swing.JTabbedPane tabPane, int tabIndex, java.awt.Graphics g, int x, int y, int w, int h)
tabPane
- Tabbed pane.tabIndex
- tabIndex Tab index for the preview paint.g
- Graphics context.x
- X coordinate of the preview area.y
- Y coordinate of the preview area.w
- Width of the preview area.h
- Height of the preview area.public boolean hasPreview(javax.swing.JTabbedPane tabPane, int tabIndex)
tabPane
- Tabbed pane.tabIndex
- Tab index for the preview paint.true
if the specified tab component is
previewable, false
otherwise.public boolean isSensitiveToEvents(javax.swing.JTabbedPane tabPane, int tabIndex)
tabPane
- Tabbed pane.tabIndex
- Tab index.true
if the specified tab component is sensitive
to events, false
otherwise.public java.awt.Rectangle getPreviewDialogScreenBounds(javax.swing.JTabbedPane tabPane)
tabPane
- Tabbed pane.public javax.swing.JFrame getModalOwner(javax.swing.JTabbedPane tabPane)
null
value, the overview
dialog will be modal for the corresponding frame.tabPane
- Tabbed pane.null
, the overview dialog for the
specified tabbed pane will be modal for the corresponding frame.public boolean hasOverviewDialog(javax.swing.JTabbedPane tabPane)
tabPane
- Tabbed pane.true
if the specified tabbed pane has an overview
dialog, false
otherwise.public boolean hasPreviewWindow(javax.swing.JTabbedPane tabPane, int tabIndex)
tabPane
- Tabbed pane.tabIndex
- Tab index.true
if the specified tabbed pane has a preview
window for the specified tab, false
otherwise.public java.awt.Dimension getPreviewWindowDimension(javax.swing.JTabbedPane tabPane, int tabIndex)
tabPane
- Tabbed pane.tabIndex
- Tab index.public int getPreviewWindowExtraDelay(javax.swing.JTabbedPane tabPane, int tabIndex)
tabPane
- Tabbed pane.tabIndex
- Tab index.public boolean toUpdatePeriodically(javax.swing.JTabbedPane tabPane)
true
, then the
implementation of getUpdateCycle(JTabbedPane)
returns the
refresh cycle length in milliseconds.tabPane
- Tabbed pane.true
if the thumbnail preview of the specified
tabbed pane should be updated periodically, false
otherwise.public int getUpdateCycle(javax.swing.JTabbedPane tabPane)
toUpdatePeriodically(JTabbedPane)
is
true
, returns the update cycle length in milliseconds.tabPane
- Tabbed pane.public LafConstants.TabOverviewKind getOverviewKind(javax.swing.JTabbedPane tabPane)
hasOverviewDialog(JTabbedPane)
returns true
for
the same tabbed pane. If hasOverviewDialog(JTabbedPane)
returns
true
, the result should be not null
.tabPane
- Tabbed pane.public boolean toDisposeOverviewOnFocusLoss()
true
, the tab overview dialog will be disposed
when it loses focus.