Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Field Details

• LIVE_DRAG_MODE

  public static final int LIVE_DRAG_MODE

  Indicates that the entire contents of the item being dragged should appear inside the desktop pane.

  See Also:

  • OUTLINE_DRAG_MODE
  • setDragMode(int)
  • Constant Field Values

• OUTLINE_DRAG_MODE

  public static final int OUTLINE_DRAG_MODE

  Indicates that an outline only of the item being dragged should appear inside the desktop pane.

  See Also:

  • LIVE_DRAG_MODE
  • setDragMode(int)
  • Constant Field Values

Constructor Details

• JDesktopPane

  public JDesktopPane()

  Creates a new JDesktopPane.

Method Details

• getUI

  public DesktopPaneUI getUI()

  Returns the L&F object that renders this component.

  Overrides:

  getUI in class JComponent

  Returns:

  the DesktopPaneUI object that renders this component

• setUI

  @BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component's LookAndFeel.") public void setUI(DesktopPaneUI ui)

  Sets the L&F object that renders this component.

  Parameters:

  ui - the DesktopPaneUI L&F object

  See Also:

  • UIDefaults.getUI(JComponent)

• setDragMode

  @BeanProperty(enumerationValues={"JDesktopPane.LIVE_DRAG_MODE","JDesktopPane.OUTLINE_DRAG_MODE"}, description="Dragging style for internal frame children.") public void setDragMode(int dragMode)

  Sets the "dragging style" used by the desktop pane. You may want to change to one mode or another for performance or aesthetic reasons.

  Parameters:

  dragMode - the style of drag to use for items in the Desktop

  Since:

  1.3

  See Also:

  • LIVE_DRAG_MODE
  • OUTLINE_DRAG_MODE

• getDragMode

  public int getDragMode()

  Gets the current "dragging style" used by the desktop pane.

  Returns:

  either Live_DRAG_MODE or OUTLINE_DRAG_MODE

  Since:

  1.3

  See Also:

  • setDragMode(int)

• getDesktopManager

  public DesktopManager getDesktopManager()

  Returns the DesktopManger that handles desktop-specific UI actions.

  Returns:

  the DesktopManger that handles desktop-specific UI actions

• setDesktopManager

  @BeanProperty(description="Desktop manager to handle the internal frames in the desktop pane.") public void setDesktopManager(DesktopManager d)

  Sets the DesktopManger that will handle desktop-specific UI actions. This may be overridden by LookAndFeel.

  Parameters:

  d - the DesktopManager to use

• updateUI

  public void updateUI()

  Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.

  Overrides:

  updateUI in class JComponent

  See Also:

  • JComponent.updateUI()

• getUIClassID

  @BeanProperty(bound=false) public String getUIClassID()

  Returns the name of the L&F class that renders this component.

  Overrides:

  getUIClassID in class JComponent

  Returns:

  the string "DesktopPaneUI"

  See Also:

  • JComponent.getUIClassID()
  • UIDefaults.getUI(JComponent)

• getAllFrames

  @BeanProperty(bound=false) public JInternalFrame[] getAllFrames()

  Returns all JInternalFrames currently displayed in the desktop. Returns iconified frames as well as expanded frames.

  Returns:

  an array of JInternalFrame objects

• getSelectedFrame

  public JInternalFrame getSelectedFrame()

  Returns the currently active JInternalFrame in this JDesktopPane, or null if no JInternalFrame is currently active.

  Returns:

  the currently active JInternalFrame or null

  Since:

  1.3

• setSelectedFrame

  public void setSelectedFrame(JInternalFrame f)

  Sets the currently active JInternalFrame in this JDesktopPane. This method is used to bridge the package gap between JDesktopPane and the platform implementation code and should not be called directly. To visually select the frame the client must call JInternalFrame.setSelected(true) to activate the frame.

  Parameters:

  f - the internal frame that's currently selected

  Since:

  1.3

  See Also:

  • JInternalFrame.setSelected(boolean)

• getAllFramesInLayer

  public JInternalFrame[] getAllFramesInLayer(int layer)

  Returns all JInternalFrames currently displayed in the specified layer of the desktop. Returns iconified frames as well expanded frames.

  Parameters:

  layer - an int specifying the desktop layer

  Returns:

  an array of JInternalFrame objects

  See Also:

  • JLayeredPane

• selectFrame

  public JInternalFrame selectFrame(boolean forward)

  Selects the next JInternalFrame in this desktop pane.

  Parameters:

  forward - a boolean indicating which direction to select in; true for forward, false for backward

  Returns:

  the JInternalFrame that was selected or null if nothing was selected

  Since:

  1.6

• addImpl

  protected void addImpl(Component comp, Object constraints, int index)

  Adds the specified component to this container at the specified index. This method also notifies the layout manager to add the component to this container's layout using the specified constraints object via the addLayoutComponent method.

  The constraints are defined by the particular layout manager being used. For example, the BorderLayout class defines five constraints: BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST, BorderLayout.WEST, and BorderLayout.CENTER.

  The GridBagLayout class requires a GridBagConstraints object. Failure to pass the correct type of constraints object results in an IllegalArgumentException.

  If the current layout manager implements LayoutManager2, then LayoutManager2.addLayoutComponent(Component,Object) is invoked on it. If the current layout manager does not implement LayoutManager2, and constraints is a String, then LayoutManager.addLayoutComponent(String,Component) is invoked on it.

  If the component is not an ancestor of this container and has a non-null parent, it is removed from its current parent before it is added to this container.

  This is the method to override if a program needs to track every add request to a container as all other add methods defer to this one. An overriding method should usually include a call to the superclass's version of the method:

  super.addImpl(comp, constraints, index)

  This method changes layout-related information, and therefore, invalidates the component hierarchy. If the container has already been displayed, the hierarchy must be validated thereafter in order to display the added component.

  Overrides:

  addImpl in class Container

  Parameters:

  comp - the component to be added

  constraints - an object expressing layout constraints for this component

  index - the position in the container's list at which to insert the component, where -1 means append to the end

  Since:

  1.6

  See Also:

  • Container.add(Component)
  • Container.add(Component, int)
  • Container.add(Component, java.lang.Object)
  • Container.invalidate()
  • LayoutManager
  • LayoutManager2

• remove

  public void remove(int index)

  Remove the indexed component from this pane. This is the absolute index, ignoring layers.

  Overrides:

  remove in class JLayeredPane

  Parameters:

  index - an int specifying the component to remove

  Since:

  1.6

  See Also:

  • JLayeredPane.getIndexOf(Component)

• removeAll

  public void removeAll()

  Removes all the components from this container.

  Overrides:

  removeAll in class JLayeredPane

  Since:

  1.6

  See Also:

  • Container.add(Component)
  • Container.remove(int)
  • Container.invalidate()

• setComponentZOrder

  public void setComponentZOrder(Component comp, int index)

  Moves the specified component to the specified z-order index in the container. The z-order determines the order that components are painted; the component with the highest z-order paints first and the component with the lowest z-order paints last. Where components overlap, the component with the lower z-order paints over the component with the higher z-order.

  If the component is a child of some other container, it is removed from that container before being added to this container. The important difference between this method and java.awt.Container.add(Component, int) is that this method doesn't call removeNotify on the component while removing it from its previous container unless necessary and when allowed by the underlying native windowing system. This way, if the component has the keyboard focus, it maintains the focus when moved to the new position.

  This property is guaranteed to apply only to lightweight non-Container components.

  This method changes layout-related information, and therefore, invalidates the component hierarchy.

  Note: Not all platforms support changing the z-order of heavyweight components from one container into another without the call to removeNotify. There is no way to detect whether a platform supports this, so developers shouldn't make any assumptions.

  Overrides:

  setComponentZOrder in class Container

  Parameters:

  comp - the component to be moved

  index - the position in the container's list to insert the component, where getComponentCount() appends to the end

  Since:

  1.6

  See Also:

  • Container.getComponentZOrder(java.awt.Component)
  • Container.invalidate()

• paramString

  protected String paramString()

  Returns a string representation of this JDesktopPane. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

  Overrides:

  paramString in class JLayeredPane

  Returns:

  a string representation of this JDesktopPane

• getAccessibleContext

  @BeanProperty(bound=false) public AccessibleContext getAccessibleContext()

  Gets the AccessibleContext associated with this JDesktopPane. For desktop panes, the AccessibleContext takes the form of an AccessibleJDesktopPane. A new AccessibleJDesktopPane instance is created if necessary.

  Specified by:

  getAccessibleContext in interface Accessible

  Overrides:

  getAccessibleContext in class JLayeredPane

  Returns:

  an AccessibleJDesktopPane that serves as the AccessibleContext of this JDesktopPane