Class TabPreviewPainter
java.lang.Object
org.pushingpixels.radiance.theming.extras.api.tabbed.TabPreviewPainter
- Direct Known Subclasses:
DefaultTabPreviewPainter
Base class for tab preview painters.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetModalOwner
(JTabbedPane tabPane) Returns the owner of the overview dialog of the specified tabbed pane.getOverviewKind
(JTabbedPane tabPane) Returns the tab overview kind for the specified tabbed pane.getPreviewDialogScreenBounds
(JTabbedPane tabPane) Returns the screen bounds of the tab preview dialog window.getPreviewWindowDimension
(JTabbedPane tabPane, int tabIndex) Returns the dimension for the tab preview window.int
getPreviewWindowExtraDelay
(JTabbedPane tabPane, int tabIndex) Returns extra delay (in milliseconds) for showing the tab preview window.int
getUpdateCycle
(JTabbedPane tabPane) If the result oftoUpdatePeriodically(JTabbedPane)
istrue
, returns the update cycle length in milliseconds.boolean
hasOverviewDialog
(JTabbedPane tabPane) Checks whether the specified tabbed pane has an overview dialog.boolean
hasPreview
(JTabbedPane tabPane, int tabIndex) Checks whether the specified tab component is previewable.boolean
hasPreviewWindow
(JTabbedPane tabPane, int tabIndex) Checks whether the specified tabbed pane has a preview window for the specified tab.boolean
isSensitiveToEvents
(JTabbedPane tabPane, int tabIndex) Checks whether the specified tab component is sensitive to events.void
previewTab
(JTabbedPane tabPane, int tabIndex, BufferedImage bufferedImage, int x, int y, int w, int h) Draws a tab preview on the specified graphics.boolean
Returns indication whether the tab overview dialog should be automatically disposed when it loses focus.boolean
toUpdatePeriodically
(JTabbedPane tabPane) Returns indication whether the thumbnail preview should be updated periodically.
-
Constructor Details
-
TabPreviewPainter
public TabPreviewPainter()
-
-
Method Details
-
previewTab
public void previewTab(JTabbedPane tabPane, int tabIndex, BufferedImage bufferedImage, int x, int y, int w, int h) Draws a tab preview on the specified graphics.- Parameters:
tabPane
- Tabbed pane.tabIndex
- tabIndex Tab index for the preview paint.bufferedImage
- Buffered image to draw the preview into.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.
-
hasPreview
Checks whether the specified tab component is previewable.- Parameters:
tabPane
- Tabbed pane.tabIndex
- Tab index for the preview paint.- Returns:
true
if the specified tab component is previewable,false
otherwise.
-
isSensitiveToEvents
Checks whether the specified tab component is sensitive to events. Overriding implementation may decide that disabled tabs do not respond to mouse and keyboard events, thus not allowing selecting the corresponding tab.- Parameters:
tabPane
- Tabbed pane.tabIndex
- Tab index.- Returns:
true
if the specified tab component is sensitive to events,false
otherwise.
-
getPreviewDialogScreenBounds
Returns the screen bounds of the tab preview dialog window.- Parameters:
tabPane
- Tabbed pane.- Returns:
- Screen bounds of the preview dialog window of the specified tabbed pane.
-
getModalOwner
Returns the owner of the overview dialog of the specified tabbed pane. If this function retuns a non-null
value, the overview dialog will be modal for the corresponding frame.- Parameters:
tabPane
- Tabbed pane.- Returns:
- If not
null
, the overview dialog for the specified tabbed pane will be modal for the corresponding frame.
-
hasOverviewDialog
Checks whether the specified tabbed pane has an overview dialog.- Parameters:
tabPane
- Tabbed pane.- Returns:
true
if the specified tabbed pane has an overview dialog,false
otherwise.
-
hasPreviewWindow
Checks whether the specified tabbed pane has a preview window for the specified tab.- Parameters:
tabPane
- Tabbed pane.tabIndex
- Tab index.- Returns:
true
if the specified tabbed pane has a preview window for the specified tab,false
otherwise.
-
getPreviewWindowDimension
Returns the dimension for the tab preview window.- Parameters:
tabPane
- Tabbed pane.tabIndex
- Tab index.- Returns:
- Dimension of the tab preview window for the specified tab in the specified tabbed pane.
-
getPreviewWindowExtraDelay
Returns extra delay (in milliseconds) for showing the tab preview window. The base delay is 2000 milliseconds (2 seconds). This function must return a non-negative value.- Parameters:
tabPane
- Tabbed pane.tabIndex
- Tab index.- Returns:
- Non-negative extra delay (in milliseconds) for showing the tab preview window.
-
toUpdatePeriodically
Returns indication whether the thumbnail preview should be updated periodically. If the return value istrue
, then the implementation ofgetUpdateCycle(JTabbedPane)
returns the refresh cycle length in milliseconds.- Parameters:
tabPane
- Tabbed pane.- Returns:
true
if the thumbnail preview of the specified tabbed pane should be updated periodically,false
otherwise.
-
getUpdateCycle
If the result oftoUpdatePeriodically(JTabbedPane)
istrue
, returns the update cycle length in milliseconds.- Parameters:
tabPane
- Tabbed pane.- Returns:
- Update cycle length in milliseconds for the thumbnail preview of the specified tabbed pane.
-
getOverviewKind
Returns the tab overview kind for the specified tabbed pane. Relevant ifhasOverviewDialog(JTabbedPane)
returnstrue
for the same tabbed pane. IfhasOverviewDialog(JTabbedPane)
returnstrue
, the result should be notnull
.- Parameters:
tabPane
- Tabbed pane.- Returns:
- Tab overview kind for the specified tabbed pane.
-
toDisposeOverviewOnFocusLoss
public boolean toDisposeOverviewOnFocusLoss()Returns indication whether the tab overview dialog should be automatically disposed when it loses focus.- Returns:
- if
true
, the tab overview dialog will be disposed when it loses focus.
-