|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
org.pushingpixels.flamingo.api.common.RichToolTipManager.JTrackableComponent
org.pushingpixels.flamingo.api.ribbon.JRibbonComponent
public class JRibbonComponent
Wrapper around core and 3rd party Swing controls to allow placing them in the
JRibbonBand
.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary | |
---|---|
static String |
uiClassID
The UI class ID string. |
Fields inherited from class javax.swing.JComponent |
---|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
JRibbonComponent(JComponent mainComponent)
Creates a simple wrapper with no icon and no caption. |
|
JRibbonComponent(ResizableIcon icon,
String caption,
JComponent mainComponent)
Creates a wrapper with an icon and a caption. |
Method Summary | |
---|---|
String |
getCaption()
Returns the caption of this wrapper component. |
RibbonElementPriority |
getDisplayPriority()
|
HorizontalAlignment |
getHorizontalAlignment()
Returns the horizontal alignment for this wrapper component. |
ResizableIcon |
getIcon()
Returns the wrapper icon of this wrapper component. |
String |
getKeyTip()
Returns the key tip for this wrapper component. |
JComponent |
getMainComponent()
Returns the wrapped component of this wrapper component. |
RichTooltip |
getRichTooltip(MouseEvent mouseEvent)
|
RibbonComponentUI |
getUI()
Returns the UI object which implements the L&F for this component. |
String |
getUIClassID()
|
boolean |
isResizingAware()
|
boolean |
isSimpleWrapper()
Returns indication whether this wrapper is simple. |
void |
setCaption(String caption)
Sets new value for the caption of this wrapper component. |
void |
setDisplayPriority(RibbonElementPriority displayPriority)
|
void |
setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
Sets the specified parameter to be the horizontal alignment for this wrapper component. |
void |
setKeyTip(String keyTip)
Sets the specified string to be the key tip for this wrapper component. |
void |
setResizingAware(boolean isResizingAware)
|
void |
setRichTooltip(RichTooltip richTooltip)
Sets the rich tooltip for this wrapper component. |
void |
updateUI()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String uiClassID
Constructor Detail |
---|
public JRibbonComponent(JComponent mainComponent)
mainComponent
- Wrapped component. Can not be null
.
IllegalArgumentException
- if mainComponent
is null
.public JRibbonComponent(ResizableIcon icon, String caption, JComponent mainComponent)
icon
- Wrapper icon. Can be null
.caption
- Wrapper caption. Can not be null
.mainComponent
- Wrapped component. Can not be null
.
IllegalArgumentException
- if caption
or mainComponent
is
null
.Method Detail |
---|
public void updateUI()
updateUI
in class JComponent
public String getUIClassID()
getUIClassID
in class JComponent
public RibbonComponentUI getUI()
RibbonUI
objectJComponent.setUI(javax.swing.plaf.ComponentUI)
public ResizableIcon getIcon()
null
.
JRibbonComponent(ResizableIcon, String, JComponent)
public String getCaption()
null
.
JRibbonComponent(ResizableIcon, String, JComponent)
public void setCaption(String caption)
caption
- The new caption.public JComponent getMainComponent()
null
.
public boolean isSimpleWrapper()
true
if both getIcon()
and
getCaption()
return null
,
false
otherwise.public String getKeyTip()
setKeyTip(String)
public void setKeyTip(String keyTip)
keyTip
property change event.
keyTip
- The new key tip for this wrapper component.public RichTooltip getRichTooltip(MouseEvent mouseEvent)
getRichTooltip
in class RichToolTipManager.JTrackableComponent
public void setRichTooltip(RichTooltip richTooltip)
richTooltip
- getRichTooltip(MouseEvent)
public HorizontalAlignment getHorizontalAlignment()
setHorizontalAlignment(HorizontalAlignment)
public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
horizontalAlignment
- The new horizontal alignment for this wrapper component.getHorizontalAlignment()
public RibbonElementPriority getDisplayPriority()
public void setDisplayPriority(RibbonElementPriority displayPriority)
public boolean isResizingAware()
public void setResizingAware(boolean isResizingAware)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |