org.apache.pivot.wtk.content
Class ButtonDataRenderer

java.lang.Object
  extended by org.apache.pivot.wtk.Component
      extended by org.apache.pivot.wtk.Container
          extended by org.apache.pivot.wtk.BoxPane
              extended by org.apache.pivot.wtk.content.ButtonDataRenderer
All Implemented Interfaces:
Iterable<Component>, Sequence<Component>, Button.DataRenderer, ConstrainedVisual, Renderer, Visual
Direct Known Subclasses:
AccordionHeaderDataRenderer, CalendarButtonDataRenderer, ListButtonDataRenderer, MenuButtonDataRenderer

public class ButtonDataRenderer
extends BoxPane
implements Button.DataRenderer

Default button data renderer.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Container
Container.EDT_Checker
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component
Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary
 
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence
Sequence.Tree<T>
 
Field Summary
protected  ImageView imageView
           
protected  Label label
           
 
Constructor Summary
ButtonDataRenderer()
           
 
Method Summary
 boolean getFillIcon()
           
 int getIconHeight()
           
 int getIconWidth()
           
 boolean getShowIcon()
           
 void render(Object data, Button button, boolean highlighted)
          Prepares the renderer for layout or paint.
 void setFillIcon(boolean fillIcon)
           
 void setIconHeight(int iconHeight)
           
 void setIconWidth(int iconWidth)
           
 void setShowIcon(boolean showIcon)
           
 void setSize(int width, int height)
          NOTE This method should only be called during layout.
 String toString(Object data)
          Converts button data to a string representation.
 
Methods inherited from class org.apache.pivot.wtk.BoxPane
getBoxPaneListeners, getOrientation, setOrientation
 
Methods inherited from class org.apache.pivot.wtk.Container
add, assertEventDispatchThread, assertEventDispatchThread, clear, containsFocus, descendantAdded, descendantGainedFocus, descendantLostFocus, descendantRemoved, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getDescendantAt, getFocusTraversalPolicy, getGraphics, getLength, getNamedComponent, indexOf, insert, invalidate, isAncestor, isDoubleBuffered, iterator, layout, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, remove, removeAll, repaint, requestFocus, setDoubleBuffered, setEventDispatchThreadChecker, setFocusTraversalPolicy, setParent, setVisible, store, transferFocus, update
 
Methods inherited from class org.apache.pivot.wtk.Component
clearFocus, contains, getAncestor, getAncestor, getAttribute, getAutomationID, getBaseline, getBaseline, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponentStateListeners, getComponentStyleListeners, getComponentTooltipListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getHeight, getHeightLimits, getLocation, getMaximumHeight, getMaximumWidth, getMenuHandler, getMinimumHeight, getMinimumWidth, getMouseLocation, getName, getNamedStyles, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getSize, getSkin, getStyles, getTooltipDelay, getTooltipText, getTooltipWrapText, getTypedStyles, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWidthLimits, getWindow, getX, getY, indexBoundsCheck, installSkin, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyReleased, keyTyped, mapPointFromAncestor, mapPointFromAncestor, mapPointToAncestor, mapPointToAncestor, mouseOver, reenterMouse, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttribute, setAutomationID, setCursor, setDragSource, setDropTarget, setEnabled, setFocused, setHeight, setHeightLimits, setHeightLimits, setLocation, setLocation, setMaximumHeight, setMaximumWidth, setMenuHandler, setMinimumHeight, setMinimumWidth, setName, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSkin, setStyleName, setStyleNames, setStyleNames, setStyles, setStyles, setTooltipDelay, setTooltipText, setTooltipWrapText, setWidth, setWidthLimits, setWidthLimits, setX, setY, toString, transferFocus, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.pivot.wtk.Renderer
getStyles
 
Methods inherited from interface org.apache.pivot.wtk.ConstrainedVisual
getBaseline, getPreferredHeight, getPreferredSize, getPreferredWidth
 
Methods inherited from interface org.apache.pivot.wtk.Visual
getBaseline, getHeight, getWidth, paint
 

Field Detail

imageView

protected ImageView imageView

label

protected Label label
Constructor Detail

ButtonDataRenderer

public ButtonDataRenderer()
Method Detail

setSize

public void setSize(int width,
                    int height)
Description copied from class: Component
NOTE This method should only be called during layout. Callers should use Component.setPreferredSize(int, int).

Specified by:
setSize in interface ConstrainedVisual
Overrides:
setSize in class Component

render

public void render(Object data,
                   Button button,
                   boolean highlighted)
Description copied from interface: Button.DataRenderer
Prepares the renderer for layout or paint.

Specified by:
render in interface Button.DataRenderer
Parameters:
data - The data to render, or null if called to calculate preferred height for skins that assume a fixed renderer height.
button - The host component.
highlighted - If true, the item is highlighted.

getIconWidth

public int getIconWidth()

setIconWidth

public void setIconWidth(int iconWidth)

getIconHeight

public int getIconHeight()

setIconHeight

public void setIconHeight(int iconHeight)

getShowIcon

public boolean getShowIcon()

setShowIcon

public void setShowIcon(boolean showIcon)

getFillIcon

public boolean getFillIcon()

setFillIcon

public void setFillIcon(boolean fillIcon)

toString

public String toString(Object data)
Description copied from interface: Button.DataRenderer
Converts button data to a string representation.

Specified by:
toString in interface Button.DataRenderer
Returns:
The data's string representation, or null if the data does not have a string representation.

Note that this method may be called often during keyboard navigation, so implementations should avoid unnecessary string allocations.