| com.jidesoft.swing.Overlayable
All known Subclasses: com.jidesoft.swing.DefaultOverlayable,
| Overlayable | | public interface Overlayable extends SwingConstants(Code) | | Overlayable provides a way to add a number of components on top of another component as the overlay components.
Usually we make a component implementing Overlayable interface although it is not required.
This interface will allow user to add/remove other components as overlay components and set their location independently.
|
| CLIENT_PROPERTY_OVERLAYABLE | | final public static String CLIENT_PROPERTY_OVERLAYABLE(Code) | | Client property. If a component has this property, the property will be an Overlyable. The component
is the actual component of the Overlayable.
|
| addOverlayComponent | | void addOverlayComponent(JComponent component)(Code) | | Adds an overlay component to the center.
Parameters:
component - the overlay component. |
| addOverlayComponent | | void addOverlayComponent(JComponent component, int location)(Code) | | Adds an overlay component at the specified location. The location could be one of the following values.
Parameters:
component - the overlay component.
Parameters:
location - the overlay location. |
| addOverlayComponent | | void addOverlayComponent(JComponent component, int location, int index)(Code) | | Adds an overlay component at the specified location. The location could be one of the following values.
Parameters:
component - the overlay component.
Parameters:
location - the overlay location.
Parameters:
index - the overlay index. 0 means the first overlay component. -1 means the last overlay component. |
| getOverlayComponents | | JComponent[] getOverlayComponents()(Code) | | Gets the overlay component.
the overlay component. |
| getOverlayLocation | | int getOverlayLocation(JComponent component)(Code) | | Gets the overlay component location. If -1, it means the component doesn't exit.
the overlay component location. |
| getOverlayLocationInsets | | Insets getOverlayLocationInsets()(Code) | | Gets the insets of the overlay component relative to the border of the component.
This will affect the actual location of the overlay component except CENTER. If an edge of the insets
is greater than 0, it will move the overlay component outwards on that edge. On the opposite,
if the value is negative, it will move inward.
the insets of the overlay component relative to the border of the component. |
| removeOverlayComponent | | void removeOverlayComponent(JComponent component)(Code) | | Removes an overlay component that was added before.
Parameters:
component - |
| setOverlayLocation | | void setOverlayLocation(JComponent component, int location)(Code) | | Sets the overlay component location. The valid values are defined in SwingConstants. They are
Parameters:
location - the overlay component location. |
| setOverlayLocationInsets | | void setOverlayLocationInsets(Insets insets)(Code) | | Sets the insets of the overlay component relative to the border of the component.
Parameters:
insets - the insets of the overlay component relative to the border of the component. |
| setOverlayVisible | | void setOverlayVisible(boolean visible)(Code) | | Sets all the overlay components visible or invisible. If you want to set one overlay component visible/invisible,
you just need to call setVisible of that component.
Parameters:
visible - true to set it visible. False to invisible. |
|
|