com.extjs.gxt.desktop.client
Class Shortcut

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.desktop.client.Shortcut

All Implemented Interfaces:

Observable, IconSupport, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget

public class Shortcut
extends Component
implements IconSupport

A selectable icon and text added to the desktop. Each shortcut requires an id that has matching css styles for the icon.

 <code>
 Shortcut s2 = new Shortcut();
 s2.setText("Accordion Window");
 s2.setId("acc-win-shortcut");
 
 #acc-win-shortcut img {
  width: 48px;
  height: 48px;
  background-image: url(../images/im48x48.png);
 }
 
 </code>
 

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.extjs.gxt.ui.client.widget.Component

afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Shortcut()
Creates a new shortcut.

Shortcut(java.lang.String id, java.lang.String text)
Creates a new shortcut.

Method Summary

void	addSelectionListener(SelectionListener<? extends ComponentEvent> listener) Adds a selection listener.
java.lang.String	getHtml() Returns the shortcut's HTML content.
com.google.gwt.user.client.ui.AbstractImagePrototype	getIcon() Returns the icon.
protected void	onClick(ComponentEvent ce)
void	onComponentEvent(ComponentEvent ce) Any events a component receives will be forwarded to this method.
protected void	onRender(com.google.gwt.user.client.Element target, int index) Subclasses must override and ensure setElement is called for lazy rendered components.
void	removeSelectionListener(SelectionListener<? extends ComponentEvent> listener) Removes a previously added listener.
void	setHtml(java.lang.String html) Sets the shortcut's html content.
void	setIcon(com.google.gwt.user.client.ui.AbstractImagePrototype icon) Sets the icon.
void	setIconStyle(java.lang.String icon) Sets the icon style.
void	setText(java.lang.String text) Sets the shortcuts text.

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, afterRender, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createComponentEvent, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, doAttachChildren, doDetachChildren, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onAttach, onBrowserEvent, onDetach, onDetachHelper, onDisable, onEnable, onEnsureDebugId, onHide, onHideContextMenu, onLoad, onRightClick, onShow, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHeight, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setPixelSize, setSize, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWidth, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onUnload, setLayoutData

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, resolvePotentialElement, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Shortcut

public Shortcut()

Creates a new shortcut.

Shortcut

public Shortcut(java.lang.String id,
                java.lang.String text)

Creates a new shortcut.

Parameters:

id - the shortcut id

text - the shortcut text

Method Detail

addSelectionListener

public void addSelectionListener(SelectionListener<? extends ComponentEvent> listener)

Adds a selection listener.

Parameters:

listener - the listener to add

getIcon

public com.google.gwt.user.client.ui.AbstractImagePrototype getIcon()

Description copied from interface: IconSupport

Returns the icon.

Specified by:

getIcon in interface IconSupport

Returns:

the icon

getHtml

public java.lang.String getHtml()

Returns the shortcut's HTML content.

Returns:

the HTML content drawn in this widget

onComponentEvent

public void onComponentEvent(ComponentEvent ce)

Description copied from class: Component

Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:

onComponentEvent in class Component

Parameters:

ce - the base event

removeSelectionListener

public void removeSelectionListener(SelectionListener<? extends ComponentEvent> listener)

Removes a previously added listener.

Parameters:

listener - the listener to be removed

setIcon

public void setIcon(com.google.gwt.user.client.ui.AbstractImagePrototype icon)

Description copied from interface: IconSupport

Sets the icon.

Specified by:

setIcon in interface IconSupport

Parameters:

icon - the icon

setIconStyle

public void setIconStyle(java.lang.String icon)

Description copied from interface: IconSupport

Sets the icon style.

Specified by:

setIconStyle in interface IconSupport

Parameters:

icon - a CSS style name

setText

public void setText(java.lang.String text)

Sets the shortcuts text.

Parameters:

text - the text to draw in the shortcut

setHtml

public void setHtml(java.lang.String html)

Sets the shortcut's html content.

Parameters:

html - the html to draw in the shortcut

onClick

protected void onClick(ComponentEvent ce)

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)

Description copied from class: Component

Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:

onRender in class Component

Parameters:

target - the target element

index - the insert location