JXPanel documentation

FRAMES NO FRAMES SUMMARY: NESTED CONSTR ENUM FIELD METHOD ELEMENT

DETAIL: FIELD CONSTR ENUM METHOD ELEMENT

org.jdesktop.swingx

Class JXPanel

public class JXPanel
extends JPanel
implements Scrollable

A simple JPanel extension that adds translucency support. This component and all of its content will be displayed with the specified "alpha" transluscency property value. It also supports the Painter API.

SinceNot specified.

VersionNot specified.

Authorrbair

Wiki javadoc Use textile entry format.

Add your comments here.

Fields inherited from java.awtComponent
BOTTOM_ALIGNMENT CENTER_ALIGNMENT LEFT_ALIGNMENT RIGHT_ALIGNMENT TOP_ALIGNMENT

Fields inherited from javax.swingJComponent
accessibleContext listenerList TOOL_TIP_TEXT_KEY ui UNDEFINED_CONDITION WHEN_ANCESTOR_OF_FOCUSED_COMPONENT WHEN_FOCUSED WHEN_IN_FOCUSED_WINDOW

Constructor Summary
JXPanel() Creates a new instance of JXPanel
JXPanel( boolean isDoubleBuffered ) No description provided.
JXPanel( LayoutManager layout ) No description provided.
JXPanel( LayoutManager layout, boolean isDoubleBuffered ) No description provided.

Method Summary
float	getAlpha() No description provided.
Painter	getBackgroundPainter() No description provided.
float	getEffectiveAlpha() Unlike other properties, alpha can be set on a component, or on one of its parents.
GradientPaint	getGradientPaint() No description provided.
Dimension	getPreferredScrollableViewportSize() No description provided.
int	getScrollableBlockIncrement( Rectangle visibleRect, int orientation, int direction ) No description provided.
boolean	getScrollableTracksViewportHeight() No description provided.
boolean	getScrollableTracksViewportWidth() No description provided.
int	getScrollableUnitIncrement( Rectangle visibleRect, int orientation, int direction ) No description provided.
boolean	isDrawGradient() No description provided.
boolean	isGradientTrackHeight() No description provided.
boolean	isGradientTrackWidth() No description provided.
boolean	isInheritAlpha() No description provided.
void	paint( Graphics g ) Overriden paint method to take into account the alpha setting
protected void	paintComponent( Graphics g ) overridden to provide gradient painting TODO: Chris says that in OGL we actually suffer here by caching the gradient paint since the OGL pipeline will render gradients on hardware for us.
void	setAlpha( float alpha ) Set the alpha transparency level for this component.
void	setBackgroundPainter( Painter p ) Specifies a Painter to use to paint the background of this JXPanel.
void	setDrawGradient( boolean b ) No description provided.
void	setGradientPaint( GradientPaint paint ) No description provided.
void	setGradientTrackHeight( boolean b ) No description provided.
void	setGradientTrackWidth( boolean b ) No description provided.
void	setInheritAlpha( boolean val ) No description provided.
void	setScrollableTracksViewportHeight( boolean scrollableTracksViewportHeight ) No description provided.
void	setScrollableTracksViewportWidth( boolean scrollableTracksViewportWidth ) No description provided.

Methods inherited from javax.accessibilityAccessible
getAccessibleContext ()

Methods inherited from java.awtComponent
action (Event, Object) add (PopupMenu) addComponentListener (ComponentListener) addFocusListener (FocusListener) addHierarchyBoundsListener (HierarchyBoundsListener) addHierarchyListener (HierarchyListener) addInputMethodListener (InputMethodListener) addKeyListener (KeyListener) addMouseListener (MouseListener) addMouseMotionListener (MouseMotionListener) addMouseWheelListener (MouseWheelListener) addNotify () addPropertyChangeListener (PropertyChangeListener) addPropertyChangeListener (String, PropertyChangeListener) applyComponentOrientation (ComponentOrientation) areFocusTraversalKeysSet (int) bounds () checkImage (Image, ImageObserver) checkImage (Image, int, int, ImageObserver) coalesceEvents (AWTEvent, AWTEvent) contains (int, int) contains (Point) createImage (ImageProducer) createImage (int, int) createVolatileImage (int, int, ImageCapabilities) createVolatileImage (int, int) deliverEvent (Event) disable () disableEvents (long) dispatchEvent (AWTEvent) doLayout () enable () enable (boolean) enableEvents (long) enableInputMethods (boolean) firePropertyChange (String, float, float) firePropertyChange (String, boolean, boolean) firePropertyChange (String, double, double) firePropertyChange (String, int, int) firePropertyChange (String, byte, byte) firePropertyChange (String, char, char) firePropertyChange (String, short, short) firePropertyChange (String, long, long) firePropertyChange (String, Object, Object) getAccessibleContext () getAlignmentX () getAlignmentY () getBackground () getBounds () getBounds (Rectangle) getColorModel () getComponentAt (int, int) getComponentAt (Point) getComponentListeners () getComponentOrientation () getCursor () getDropTarget () getFocusCycleRootAncestor () getFocusListeners () getFocusTraversalKeys (int) getFocusTraversalKeysEnabled () getFont () getFontMetrics (Font) getForeground () getGraphics () getGraphicsConfiguration () getHeight () getHierarchyBoundsListeners () getHierarchyListeners () getIgnoreRepaint () getInputContext () getInputMethodListeners () getInputMethodRequests () getKeyListeners () getListeners (Class<T>) getLocale () getLocation (Point) getLocation () getLocationOnScreen () getMaximumSize () getMinimumSize () getMouseListeners () getMouseMotionListeners () getMousePosition () getMouseWheelListeners () getName () getParent () getPeer () getPreferredSize () getPropertyChangeListeners () getPropertyChangeListeners (String) getSize (Dimension) getSize () getToolkit () getTreeLock () getWidth () getX () getY () gotFocus (Event, Object) handleEvent (Event) hasFocus () hide () imageUpdate (Image, int, int, int, int, int) inside (int, int) invalidate () isBackgroundSet () isCursorSet () isDisplayable () isDoubleBuffered () isEnabled () isFocusable () isFocusCycleRoot (Container) isFocusOwner () isFocusTraversable () isFontSet () isForegroundSet () isLightweight () isMaximumSizeSet () isMinimumSizeSet () isOpaque () isPreferredSizeSet () isShowing () isValid () isVisible () keyDown (Event, int) keyUp (Event, int) layout () list () list (PrintStream) list (PrintStream, int) list (PrintWriter) list (PrintWriter, int) locate (int, int) location () lostFocus (Event, Object) minimumSize () mouseDown (Event, int, int) mouseDrag (Event, int, int) mouseEnter (Event, int, int) mouseExit (Event, int, int) mouseMove (Event, int, int) mouseUp (Event, int, int) move (int, int) nextFocus () paintAll (Graphics) paramString () postEvent (Event) preferredSize () prepareImage (Image, ImageObserver) prepareImage (Image, int, int, ImageObserver) print (Graphics) printAll (Graphics) processComponentEvent (ComponentEvent) processEvent (AWTEvent) processFocusEvent (FocusEvent) processHierarchyBoundsEvent (HierarchyEvent) processHierarchyEvent (HierarchyEvent) processInputMethodEvent (InputMethodEvent) processKeyEvent (KeyEvent) processMouseEvent (MouseEvent) processMouseMotionEvent (MouseEvent) processMouseWheelEvent (MouseWheelEvent) remove (MenuComponent) removeComponentListener (ComponentListener) removeFocusListener (FocusListener) removeHierarchyBoundsListener (HierarchyBoundsListener) removeHierarchyListener (HierarchyListener) removeInputMethodListener (InputMethodListener) removeKeyListener (KeyListener) removeMouseListener (MouseListener) removeMouseMotionListener (MouseMotionListener) removeMouseWheelListener (MouseWheelListener) removeNotify () removePropertyChangeListener (PropertyChangeListener) removePropertyChangeListener (String, PropertyChangeListener) repaint () repaint (long) repaint (int, int, int, int) repaint (long, int, int, int, int) requestFocus () requestFocus (boolean) requestFocusInWindow () requestFocusInWindow (boolean) reshape (int, int, int, int) resize (int, int) resize (Dimension) setBackground (Color) setBounds (Rectangle) setBounds (int, int, int, int) setComponentOrientation (ComponentOrientation) setCursor (Cursor) setDropTarget (DropTarget) setEnabled (boolean) setFocusable (boolean) setFocusTraversalKeys (int, Set<? extends AWTKeyStroke>) setFocusTraversalKeysEnabled (boolean) setFont (Font) setForeground (Color) setIgnoreRepaint (boolean) setLocale (Locale) setLocation (int, int) setLocation (Point) setMaximumSize (Dimension) setMinimumSize (Dimension) setName (String) setPreferredSize (Dimension) setSize (Dimension) setSize (int, int) setVisible (boolean) show () show (boolean) size () toString () transferFocus () transferFocusBackward () transferFocusUpCycle () update (Graphics) validate ()

Methods inherited from java.awtComponent

Methods inherited from java.awtContainer
add (Component, int) add (Component, Object) add (Component, Object, int) add (Component) add (String, Component) addContainerListener (ContainerListener) addImpl (Component, Object, int) addNotify () addPropertyChangeListener (PropertyChangeListener) addPropertyChangeListener (String, PropertyChangeListener) applyComponentOrientation (ComponentOrientation) areFocusTraversalKeysSet (int) countComponents () deliverEvent (Event) doLayout () findComponentAt (int, int) findComponentAt (Point) getAlignmentX () getAlignmentY () getComponent (int) getComponentAt (int, int) getComponentAt (Point) getComponentCount () getComponents () getComponentZOrder (Component) getContainerListeners () getFocusTraversalKeys (int) getFocusTraversalPolicy () getInsets () getLayout () getListeners (Class<T>) getMaximumSize () getMinimumSize () getMousePosition (boolean) getPreferredSize () insets () invalidate () isAncestorOf (Component) isFocusCycleRoot () isFocusCycleRoot (Container) isFocusTraversalPolicyProvider () isFocusTraversalPolicySet () layout () list (PrintStream, int) list (PrintWriter, int) locate (int, int) minimumSize () paintComponents (Graphics) paramString () preferredSize () print (Graphics) printComponents (Graphics) processContainerEvent (ContainerEvent) processEvent (AWTEvent) remove (Component) remove (int) removeAll () removeContainerListener (ContainerListener) removeNotify () setComponentZOrder (Component, int) setFocusCycleRoot (boolean) setFocusTraversalKeys (int, Set<? extends AWTKeyStroke>) setFocusTraversalPolicy (FocusTraversalPolicy) setFocusTraversalPolicyProvider (boolean) setFont (Font) setLayout (LayoutManager) transferFocusBackward () transferFocusDownCycle () update (Graphics) validate () validateTree ()

Methods inherited from java.awtContainer

Methods inherited from java.awt.imageImageObserver
imageUpdate (Image, int, int, int, int, int)

Methods inherited from javax.swingJComponent
addAncestorListener (AncestorListener) addNotify () addVetoableChangeListener (VetoableChangeListener) computeVisibleRect (Rectangle) contains (int, int) createToolTip () disable () enable () firePropertyChange (String, boolean, boolean) firePropertyChange (String, int, int) firePropertyChange (String, char, char) fireVetoableChange (String, Object, Object) getAccessibleContext () getActionForKeyStroke (KeyStroke) getActionMap () getAlignmentX () getAlignmentY () getAncestorListeners () getAutoscrolls () getBorder () getBounds (Rectangle) getClientProperty (Object) getComponentGraphics (Graphics) getComponentPopupMenu () getConditionForKeyStroke (KeyStroke) getDebugGraphicsOptions () getDefaultLocale () getFontMetrics (Font) getGraphics () getHeight () getInheritsPopupMenu () getInputMap (int) getInputMap () getInputVerifier () getInsets () getInsets (Insets) getListeners (Class<T>) getLocation (Point) getMaximumSize () getMinimumSize () getNextFocusableComponent () getPopupLocation (MouseEvent) getPreferredSize () getRegisteredKeyStrokes () getRootPane () getSize (Dimension) getToolTipLocation (MouseEvent) getToolTipText () getToolTipText (MouseEvent) getTopLevelAncestor () getTransferHandler () getUIClassID () getVerifyInputWhenFocusTarget () getVetoableChangeListeners () getVisibleRect () getWidth () getX () getY () grabFocus () isDoubleBuffered () isLightweightComponent (Component) isManagingFocus () isOpaque () isOptimizedDrawingEnabled () isPaintingTile () isRequestFocusEnabled () isValidateRoot () paintBorder (Graphics) paintChildren (Graphics) paintImmediately (int, int, int, int) paintImmediately (Rectangle) paramString () print (Graphics) printAll (Graphics) printBorder (Graphics) printChildren (Graphics) printComponent (Graphics) processComponentKeyEvent (KeyEvent) processKeyBinding (KeyStroke, KeyEvent, int, boolean) processKeyEvent (KeyEvent) processMouseEvent (MouseEvent) processMouseMotionEvent (MouseEvent) putClientProperty (Object, Object) registerKeyboardAction (ActionListener, String, KeyStroke, int) registerKeyboardAction (ActionListener, KeyStroke, int) removeAncestorListener (AncestorListener) removeNotify () removeVetoableChangeListener (VetoableChangeListener) repaint (long, int, int, int, int) repaint (Rectangle) requestDefaultFocus () requestFocus () requestFocus (boolean) requestFocusInWindow (boolean) requestFocusInWindow () resetKeyboardActions () reshape (int, int, int, int) revalidate () scrollRectToVisible (Rectangle) setActionMap (ActionMap) setAlignmentX (float) setAlignmentY (float) setAutoscrolls (boolean) setBackground (Color) setBorder (Border) setComponentPopupMenu (JPopupMenu) setDebugGraphicsOptions (int) setDefaultLocale (Locale) setDoubleBuffered (boolean) setEnabled (boolean) setFocusTraversalKeys (int, Set<? extends AWTKeyStroke>) setFont (Font) setForeground (Color) setInheritsPopupMenu (boolean) setInputMap (int, InputMap) setInputVerifier (InputVerifier) setMaximumSize (Dimension) setMinimumSize (Dimension) setNextFocusableComponent (Component) setOpaque (boolean) setPreferredSize (Dimension) setRequestFocusEnabled (boolean) setToolTipText (String) setTransferHandler (TransferHandler) setUI (ComponentUI) setVerifyInputWhenFocusTarget (boolean) setVisible (boolean) unregisterKeyboardAction (KeyStroke) update (Graphics) updateUI ()

Methods inherited from javax.swingJComponent

Methods inherited from javax.swingJPanel
getAccessibleContext () getUI () getUIClassID () paramString () setUI (PanelUI) updateUI ()

Methods inherited from java.awtMenuContainer
getFont () postEvent (Event) remove (MenuComponent)

Methods inherited from java.langObject
clone () equals (Object) finalize () getClass () hashCode () notify () notifyAll () toString () wait (long) wait (long, int) wait ()

Constructor Detail

JXPanel

public JXPanel ( )

Creates a new instance of JXPanel

Wiki javadoc Use textile entry format.

Add your comments here.

JXPanel

public JXPanel ( boolean isDoubleBuffered )

No description provided.

Parameters

Type	Name	Description
boolean	isDoubleBuffered	No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

JXPanel

public JXPanel ( LayoutManager layout )

No description provided.

Parameters

Type	Name	Description
LayoutManager	layout	No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

JXPanel

public JXPanel ( LayoutManager layout, boolean isDoubleBuffered )

No description provided.

Parameters

Type	Name	Description
LayoutManager	layout	No description provided.
boolean	isDoubleBuffered	No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

Method Detail

getAlpha

public float getAlpha ( )

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

getBackgroundPainter

public Painter getBackgroundPainter ( )

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

getEffectiveAlpha

public float getEffectiveAlpha ( )

Unlike other properties, alpha can be set on a component, or on one of its parents. If the alpha of a parent component is .4, and the alpha on this component is .5, effectively the alpha for this component is .4 because the lowest alpha in the heirarchy "wins"

Wiki javadoc Use textile entry format.

Add your comments here.

getGradientPaint

public GradientPaint getGradientPaint ( )

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize ( )

No description provided.

Implements method in Scrollable

Wiki javadoc Use textile entry format.

Add your comments here.

getScrollableBlockIncrement

public int getScrollableBlockIncrement ( Rectangle visibleRect, int orientation, int direction )

No description provided.

Implements method in Scrollable

Parameters

Type	Name	Description
Rectangle	visibleRect	No description provided.
int	orientation	No description provided.
int	direction	No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight ( )

No description provided.

Implements method in Scrollable

Wiki javadoc Use textile entry format.

Add your comments here.

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth ( )

No description provided.

Implements method in Scrollable

Wiki javadoc Use textile entry format.

Add your comments here.

getScrollableUnitIncrement

public int getScrollableUnitIncrement ( Rectangle visibleRect, int orientation, int direction )

No description provided.

Implements method in Scrollable

Parameters

Type	Name	Description
Rectangle	visibleRect	No description provided.
int	orientation	No description provided.
int	direction	No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

isDrawGradient

public boolean isDrawGradient ( )

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

isGradientTrackHeight

public boolean isGradientTrackHeight ( )

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

isGradientTrackWidth

public boolean isGradientTrackWidth ( )

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

isInheritAlpha

public boolean isInheritAlpha ( )

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

paint

@Override ()

public void paint ( Graphics g )

Overriden paint method to take into account the alpha setting

Overrides method in JComponent

Parameters

Type	Name	Description
Graphics	g	No description provided.

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

paintComponent

@Override ()

protected void paintComponent ( Graphics g )

overridden to provide gradient painting TODO: Chris says that in OGL we actually suffer here by caching the gradient paint since the OGL pipeline will render gradients on hardware for us. The decision to use cacheing is based on my experience with gradient title borders slowing down repaints -- this could use more extensive analysis.

Overrides method in JComponent

Parameters

Type	Name	Description
Graphics	g	No description provided.

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setAlpha

public void setAlpha ( float alpha )

Set the alpha transparency level for this component. This automatically causes a repaint of the component.

TODO add support for animated changes in translucency

Parameters

Type	Name	Description
float	alpha	must be a value between 0 and 1 inclusive.

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setBackgroundPainter

public void setBackgroundPainter ( Painter p )

Specifies a Painter to use to paint the background of this JXPanel. If p is not null, then setOpaque(false) will be called as a side effect. A component should not be opaque if painters are being used, because Painters may paint transparent pixels or not paint certain pixels, such as around the border insets.

Parameters

Type	Name	Description
Painter	p	No description provided.

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setDrawGradient

public void setDrawGradient ( boolean b )

No description provided.

Parameters

Type	Name	Description
boolean	b	No description provided.

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setGradientPaint

public void setGradientPaint ( GradientPaint paint )

No description provided.

Parameters

Type	Name	Description
GradientPaint	paint	No description provided.

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setGradientTrackHeight

public void setGradientTrackHeight ( boolean b )

No description provided.

Parameters

Type	Name	Description
boolean	b	No description provided.

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setGradientTrackWidth

public void setGradientTrackWidth ( boolean b )

No description provided.

Parameters

Type	Name	Description
boolean	b	No description provided.

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setInheritAlpha

public void setInheritAlpha ( boolean val )

No description provided.

Parameters

Type	Name	Description
boolean	val	No description provided.

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setScrollableTracksViewportHeight

public void setScrollableTracksViewportHeight ( boolean scrollableTracksViewportHeight )

No description provided.

Parameters

Type	Name	Description
boolean	scrollableTracksViewportHeight	The scrollableTracksViewportHeight to set.

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setScrollableTracksViewportWidth

public void setScrollableTracksViewportWidth ( boolean scrollableTracksViewportWidth )

No description provided.

Parameters

Type	Name	Description
boolean	scrollableTracksViewportWidth	The scrollableTracksViewportWidth to set.

Returns void No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.