Package org.apache.pivot.wtk.skin.terra
Class TerraFrameSkin
- java.lang.Object
-
- org.apache.pivot.wtk.skin.ComponentSkin
-
- org.apache.pivot.wtk.skin.ContainerSkin
-
- org.apache.pivot.wtk.skin.WindowSkin
-
- org.apache.pivot.wtk.skin.terra.TerraFrameSkin
-
- All Implemented Interfaces:
ComponentKeyListener,ComponentListener,ComponentMouseButtonListener,ComponentMouseListener,ComponentMouseWheelListener,ComponentStateListener,ComponentTooltipListener,ConstrainedVisual,ContainerListener,ContainerMouseListener,FrameListener,Skin,Visual,Window.Skin,WindowListener,WindowStateListener
- Direct Known Subclasses:
TerraDialogSkin
public class TerraFrameSkin extends WindowSkin implements FrameListener
Frame skin.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classTerraFrameSkin.ButtonImageAbstract base class for frame button images.protected classTerraFrameSkin.CloseImageClose button image.static classTerraFrameSkin.FrameButtonFrame button.static classTerraFrameSkin.FrameButtonSkinFrame button skin.protected classTerraFrameSkin.MaximizeImageMaximize button image.protected classTerraFrameSkin.MinimizeImageMinimize button image.protected classTerraFrameSkin.ResizeImageResize button image.protected classTerraFrameSkin.RestoreImageRestore button image.-
Nested classes/interfaces inherited from class org.apache.pivot.wtk.skin.ContainerSkin
ContainerSkin.IndexFocusTraversalPolicy
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentKeyListener
ComponentKeyListener.Adapter, ComponentKeyListener.Listeners
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentListener
ComponentListener.Adapter, ComponentListener.Listeners
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseButtonListener
ComponentMouseButtonListener.Adapter, ComponentMouseButtonListener.Listeners
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseListener
ComponentMouseListener.Adapter, ComponentMouseListener.Listeners
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseWheelListener
ComponentMouseWheelListener.Listeners
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentStateListener
ComponentStateListener.Adapter, ComponentStateListener.Listeners
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentTooltipListener
ComponentTooltipListener.Listeners
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ContainerListener
ContainerListener.Adapter, ContainerListener.Listeners
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ContainerMouseListener
ContainerMouseListener.Adapter, ContainerMouseListener.Listeners
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.FrameListener
FrameListener.Listeners
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.WindowListener
WindowListener.Adapter, WindowListener.Listeners
-
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.WindowStateListener
WindowStateListener.Adapter, WindowStateListener.Listeners
-
-
Field Summary
Fields Modifier and Type Field Description protected static intALPHA
-
Constructor Summary
Constructors Constructor Description TerraFrameSkin()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidactiveChanged(Window window, Window obverseWindow)Called when a window's active state has changed.BoundsgetClientArea()InsetsgetPadding()intgetPreferredHeight(int width)Returns the visual's preferred height given the provided width constraint.DimensionsgetPreferredSize()Returns the visual's unconstrained preferred size.intgetPreferredWidth(int height)Returns the visual's preferred width given the provided height constraint.booleangetShowCloseButton()booleangetShowContentBevel()booleangetShowMaximizeButton()booleangetShowMinimizeButton()booleangetShowWindowControls()voidiconAdded(Window window, Image addedIcon)Called when an icon has been added to a window.voidiconsRemoved(Window window, int index, Sequence<Image> removed)Called when one or more of the window's icons were removed.voidinstall(Component component)Must be implemented in every subclass in order to do component-specific operations at instantiation time, but every subclass must call this superclass method to setup the necessary listeners, etc.booleanisResizable()booleankeyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation)Keyboard handling (Tab key or Shift Tab).voidlayout()If the component on which the skin is installed is a container, lays out the container's children.voidmaximizedChanged(Window window)Called when a window's maximized state has changed.voidmenuBarChanged(Frame frame, MenuBar previousMenuBar)Called when a frame's menu bar has changed.booleanmouseDown(Component component, Mouse.Button button, int x, int y)Called when a mouse button is pressed over a component.booleanmouseMove(Component component, int x, int y)Called when the mouse is moved over a component.booleanmouseUp(Component component, Mouse.Button button, int x, int y)Called when a mouse button is released over a component.voidpaint(java.awt.Graphics2D graphics)Paints the visual.voidsetBackgroundColor(java.awt.Color backgroundColor)Sets the background of the container to a solid color.voidsetPadding(int padding)voidsetPadding(java.lang.Number padding)voidsetPadding(java.lang.String padding)voidsetPadding(Dictionary<java.lang.String,?> padding)voidsetPadding(Sequence<?> padding)voidsetPadding(Insets padding)voidsetResizable(boolean resizable)voidsetShowCloseButton(boolean showCloseButton)voidsetShowContentBevel(boolean showContentBevel)voidsetShowMaximizeButton(boolean showMaximizeButton)voidsetShowMinimizeButton(boolean showMinimizeButton)voidsetShowWindowControls(boolean showWindowControls)voidtitleChanged(Window window, java.lang.String previousTitle)Called when a window's title has changed.-
Methods inherited from class org.apache.pivot.wtk.skin.WindowSkin
contentChanged, mouseDown, windowClosed
-
Methods inherited from class org.apache.pivot.wtk.skin.ContainerSkin
componentInserted, componentMoved, componentsRemoved, focusTraversalPolicyChanged, getBackgroundColor, getBackgroundPaint, isFocusable, isOpaque, mouseMove, mouseUp, mouseWheel, setBackgroundColor, setBackgroundColor, setBackgroundPaint, setBackgroundPaint, setBackgroundPaint
-
Methods inherited from class org.apache.pivot.wtk.skin.ComponentSkin
colorFromObject, colorFromObject, colorFromObject, colorFromObject, currentTheme, cursorChanged, decodeFont, defaultBackgroundColor, defaultForegroundColor, dragSourceChanged, dropTargetChanged, enabledChanged, focusedChanged, fontFromObject, getBaseline, getBaseline, getColor, getComponent, getFocusRectangleStroke, getHeight, getSize, getTextInputMethodListener, getThemeFont, getWidth, heightLimitsChanged, invalidateComponent, keyReleased, keyTyped, locationChanged, menuHandlerChanged, mouseClick, mouseOut, mouseOver, mouseWheel, nameChanged, parentChanged, preferredSizeChanged, repaintComponent, repaintComponent, repaintComponent, repaintComponent, repaintComponent, setDefaultStyles, setSize, sizeChanged, themeHasThickFocusRectangle, themeHasTransitionEnabled, themeIsDark, themeIsFlat, tooltipDelayChanged, tooltipTextChanged, tooltipTriggered, visibleChanged, widthLimitsChanged
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.pivot.wtk.ConstrainedVisual
getBaseline, setSize, setSize
-
Methods inherited from interface org.apache.pivot.wtk.Skin
getComponent, isFocusable, isOpaque
-
Methods inherited from interface org.apache.pivot.wtk.Visual
getBaseline, getHeight, getSize, getWidth
-
Methods inherited from interface org.apache.pivot.wtk.WindowListener
iconInserted
-
Methods inherited from interface org.apache.pivot.wtk.WindowStateListener
previewWindowClose, previewWindowOpen, windowCloseVetoed, windowOpened, windowOpenVetoed
-
-
-
-
Field Detail
-
ALPHA
protected static final int ALPHA
- See Also:
- Constant Field Values
-
-
Method Detail
-
install
public void install(Component component)
Description copied from class:ComponentSkinMust be implemented in every subclass in order to do component-specific operations at instantiation time, but every subclass must call this superclass method to setup the necessary listeners, etc.- Specified by:
installin interfaceSkin- Overrides:
installin classWindowSkin- Parameters:
component- The component to which the skin is being attached.
-
getPreferredWidth
public int getPreferredWidth(int height)
Description copied from interface:ConstrainedVisualReturns the visual's preferred width given the provided height constraint.- Specified by:
getPreferredWidthin interfaceConstrainedVisual- Overrides:
getPreferredWidthin classWindowSkin- Parameters:
height- The height by which to constrain the preferred width, or-1for no constraint.- Returns:
- The preferred width given the height constraint.
-
getPreferredHeight
public int getPreferredHeight(int width)
Description copied from interface:ConstrainedVisualReturns the visual's preferred height given the provided width constraint.- Specified by:
getPreferredHeightin interfaceConstrainedVisual- Overrides:
getPreferredHeightin classWindowSkin- Parameters:
width- The width by which to constrain the preferred height, or-1for no constraint.- Returns:
- The preferred height given the width constraint.
-
getPreferredSize
public Dimensions getPreferredSize()
Description copied from interface:ConstrainedVisualReturns the visual's unconstrained preferred size.- Specified by:
getPreferredSizein interfaceConstrainedVisual- Overrides:
getPreferredSizein classWindowSkin- Returns:
- The preferred size (width and height) of this component.
Depending on the component this can be a static value or derived (as for a container) from its subcomponents, etc.
The default implementation simply calls
ConstrainedVisual.getPreferredWidth(int)andConstrainedVisual.getPreferredHeight(int).
-
layout
public void layout()
Description copied from interface:SkinIf the component on which the skin is installed is a container, lays out the container's children.- Specified by:
layoutin interfaceSkin- Overrides:
layoutin classWindowSkin
-
paint
public void paint(java.awt.Graphics2D graphics)
Description copied from interface:VisualPaints the visual.- Specified by:
paintin interfaceVisual- Overrides:
paintin classContainerSkin- Parameters:
graphics- The graphics context in which to paint the visual.
-
getClientArea
public Bounds getClientArea()
- Specified by:
getClientAreain interfaceWindow.Skin- Overrides:
getClientAreain classWindowSkin
-
setBackgroundColor
public void setBackgroundColor(java.awt.Color backgroundColor)
Description copied from class:ContainerSkinSets the background of the container to a solid color.- Overrides:
setBackgroundColorin classContainerSkin- Parameters:
backgroundColor- The new background color for the container.
-
getShowMinimizeButton
public boolean getShowMinimizeButton()
-
setShowMinimizeButton
public void setShowMinimizeButton(boolean showMinimizeButton)
-
getShowMaximizeButton
public boolean getShowMaximizeButton()
-
setShowMaximizeButton
public void setShowMaximizeButton(boolean showMaximizeButton)
-
getShowCloseButton
public boolean getShowCloseButton()
-
setShowCloseButton
public void setShowCloseButton(boolean showCloseButton)
-
getShowWindowControls
public boolean getShowWindowControls()
-
setShowWindowControls
public void setShowWindowControls(boolean showWindowControls)
-
getPadding
public Insets getPadding()
-
setPadding
public void setPadding(Insets padding)
-
setPadding
public final void setPadding(Dictionary<java.lang.String,?> padding)
-
setPadding
public final void setPadding(Sequence<?> padding)
-
setPadding
public final void setPadding(int padding)
-
setPadding
public final void setPadding(java.lang.Number padding)
-
setPadding
public final void setPadding(java.lang.String padding)
-
isResizable
public boolean isResizable()
-
setResizable
public void setResizable(boolean resizable)
-
getShowContentBevel
public boolean getShowContentBevel()
-
setShowContentBevel
public void setShowContentBevel(boolean showContentBevel)
-
mouseMove
public boolean mouseMove(Component component, int x, int y)
Description copied from interface:ComponentMouseListenerCalled when the mouse is moved over a component.- Specified by:
mouseMovein interfaceComponentMouseListener- Overrides:
mouseMovein classComponentSkin- Parameters:
component- Component that is under the mouse.x- X position of the mouse.y- Y position of the mouse.- Returns:
trueto consume the event;falseto allow it to propagate (default return).
-
mouseDown
public boolean mouseDown(Component component, Mouse.Button button, int x, int y)
Description copied from interface:ComponentMouseButtonListenerCalled when a mouse button is pressed over a component.- Specified by:
mouseDownin interfaceComponentMouseButtonListener- Overrides:
mouseDownin classComponentSkin- Parameters:
component- Component that is under the mouse pointer.button- Which mouse button was pressed.x- X position of the mouse.y- Y position of the mouse.- Returns:
trueto consume the event;falseto allow it to propagate (default).
-
mouseUp
public boolean mouseUp(Component component, Mouse.Button button, int x, int y)
Description copied from interface:ComponentMouseButtonListenerCalled when a mouse button is released over a component.- Specified by:
mouseUpin interfaceComponentMouseButtonListener- Overrides:
mouseUpin classComponentSkin- Parameters:
component- Component user the mouse pointer.button- Which mouse button that was released.x- X position of the mouse.y- Y position of the mouse.- Returns:
trueto consume the event;falseto allow it to propagate (default).
-
keyPressed
public boolean keyPressed(Component component, int keyCode, Keyboard.KeyLocation keyLocation)
Description copied from class:ComponentSkinKeyboard handling (Tab key or Shift Tab).- Specified by:
keyPressedin interfaceComponentKeyListener- Overrides:
keyPressedin classComponentSkin- Parameters:
component- Component that has the focus.keyCode- The key code for the key that was pressed.keyLocation- Location value for the key (left or right for shift keys, etc.).- Returns:
trueto consume the event;falseto allow it to propagate.
-
titleChanged
public void titleChanged(Window window, java.lang.String previousTitle)
Description copied from interface:WindowListenerCalled when a window's title has changed.- Specified by:
titleChangedin interfaceWindowListener- Parameters:
window- The window whose title has changed.previousTitle- What the title was previously (can benull).
-
iconAdded
public void iconAdded(Window window, Image addedIcon)
Description copied from interface:WindowListenerCalled when an icon has been added to a window.- Specified by:
iconAddedin interfaceWindowListener- Parameters:
window- The window that has changed.addedIcon- The icon that was added.
-
iconsRemoved
public void iconsRemoved(Window window, int index, Sequence<Image> removed)
Description copied from interface:WindowListenerCalled when one or more of the window's icons were removed.- Specified by:
iconsRemovedin interfaceWindowListener- Parameters:
window- The window that has changed.index- Starting index of the icons that were removed in the window's icon sequence.removed- The sequence of icons that were actually removed.
-
activeChanged
public void activeChanged(Window window, Window obverseWindow)
Description copied from interface:WindowListenerCalled when a window's active state has changed.- Specified by:
activeChangedin interfaceWindowListener- Parameters:
window- The window that has changed its active state.obverseWindow- The "other" window that is affected.
-
maximizedChanged
public void maximizedChanged(Window window)
Description copied from interface:WindowListenerCalled when a window's maximized state has changed.- Specified by:
maximizedChangedin interfaceWindowListener- Parameters:
window- The window whose state has changed.
-
menuBarChanged
public void menuBarChanged(Frame frame, MenuBar previousMenuBar)
Description copied from interface:FrameListenerCalled when a frame's menu bar has changed.- Specified by:
menuBarChangedin interfaceFrameListener- Parameters:
frame- The frame that has changed.previousMenuBar- The previous menu bar for this frame.
-
-