Form Builder NG Model 6.0.0-SNAPSHOT

org.jbpm.form.builder.ng.model.shared.menu.items
Class CustomMenuItem

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.google.gwt.user.client.ui.Panel
              extended by com.google.gwt.user.client.ui.ComplexPanel
                  extended by com.google.gwt.user.client.ui.AbsolutePanel
                      extended by org.jbpm.form.builder.ng.model.client.menu.FBMenuItem
                          extended by org.jbpm.form.builder.ng.model.shared.menu.items.CustomMenuItem
All Implemented Interfaces:
com.allen_sauer.gwt.dnd.client.HasDragHandle, 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.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>

public class CustomMenuItem
extends FBMenuItem

This class is used to store a POJO representation of a complex item that can be extrapolated from other simpler items, and allow the user to use them by having it as a custom menu option


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
 
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel
com.google.gwt.user.client.ui.InsertPanel.ForIsWidget
 
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets
com.google.gwt.user.client.ui.HasWidgets.ForIsWidget
 
Field Summary
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
CustomMenuItem()
           
CustomMenuItem(FormBuilderDTO representation, String optionName, List<FBFormEffect> formEffects, String groupName)
           
 
Method Summary
 void addEffect(FBFormEffect effect)
           
 FBFormItem buildWidget()
          Builds a FBFormItem.
 FBMenuItem cloneWidget()
          This method is like Object.clone(), but returns the proper instance and forces implementation
 com.google.gwt.user.client.ui.Label getDescription()
          This method returns a description that represents the UI component this menu item creates.
 String getGroupName()
           
protected  com.google.gwt.resources.client.ImageResource getIconUrl()
          This method returns an icon that visually represents the UI component this menu item creates.
protected  String getIconUrlAsString()
          This method can be overriden so that you can specify at runtime the URL of an icon.
 String getItemId()
           
 String getOptionName()
           
 FormBuilderDTO getRepresentation()
           
 void onBrowserEvent(com.google.gwt.user.client.Event event)
           
 void setGroupName(String groupName)
           
 void setIconUrlAsString(String iconUrlAsString)
           
 void setOptionName(String optionName)
           
 void setRepresentation(FormBuilderDTO representation)
           
 
Methods inherited from class org.jbpm.form.builder.ng.model.client.menu.FBMenuItem
addAllowedEvent, build, clone, getAllowedEvents, getAllowedEventsAsMap, getDragHandle, getFormEffects, onLoad, onUnload, repaint, setItemSelectionHandler, setPixelSize, setSize
 
Methods inherited from class com.google.gwt.user.client.ui.AbsolutePanel
add, add, add, getWidgetLeft, getWidgetTop, insert, insert, insert, remove, setWidgetPosition, setWidgetPositionImpl
 
Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel
add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove
 
Methods inherited from class com.google.gwt.user.client.ui.Panel
add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove
 
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, onAttach, onDetach, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget
add
 
Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget
getWidgetIndex
 
Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel
getWidget, getWidgetCount, getWidgetIndex, remove
 

Constructor Detail

CustomMenuItem

public CustomMenuItem()

CustomMenuItem

public CustomMenuItem(FormBuilderDTO representation,
                      String optionName,
                      List<FBFormEffect> formEffects,
                      String groupName)
Method Detail

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)
Specified by:
onBrowserEvent in interface com.google.gwt.user.client.EventListener
Overrides:
onBrowserEvent in class com.google.gwt.user.client.ui.Widget

getOptionName

public String getOptionName()

getRepresentation

public FormBuilderDTO getRepresentation()

setRepresentation

public void setRepresentation(FormBuilderDTO representation)

setOptionName

public void setOptionName(String optionName)

getGroupName

public String getGroupName()

setGroupName

public void setGroupName(String groupName)

getIconUrlAsString

protected String getIconUrlAsString()
Description copied from class: FBMenuItem
This method can be overriden so that you can specify at runtime the URL of an icon.

Overrides:
getIconUrlAsString in class FBMenuItem
Returns:
an URL, but it will always return null unless you override it

setIconUrlAsString

public void setIconUrlAsString(String iconUrlAsString)

getIconUrl

protected com.google.gwt.resources.client.ImageResource getIconUrl()
Description copied from class: FBMenuItem
This method returns an icon that visually represents the UI component this menu item creates.

Specified by:
getIconUrl in class FBMenuItem
Returns:
an icon

getDescription

public com.google.gwt.user.client.ui.Label getDescription()
Description copied from class: FBMenuItem
This method returns a description that represents the UI component this menu item creates.

Specified by:
getDescription in class FBMenuItem
Returns:
a description label

cloneWidget

public FBMenuItem cloneWidget()
Description copied from class: FBMenuItem
This method is like Object.clone(), but returns the proper instance and forces implementation

Specified by:
cloneWidget in class FBMenuItem
Returns:
a copy of this FBMenuItem object

addEffect

public void addEffect(FBFormEffect effect)
Overrides:
addEffect in class FBMenuItem

buildWidget

public FBFormItem buildWidget()
Description copied from class: FBMenuItem
Builds a FBFormItem. Remember to assign all FBFormEffect it will need. See FBMenuItem.getFormEffects() and FBMenuItem.FBMenuItem(List) to see how to assign and get these to and from your instance.

Specified by:
buildWidget in class FBMenuItem
Returns:
a FBFormItem instance.

getItemId

public String getItemId()
Overrides:
getItemId in class FBMenuItem

Form Builder NG Model 6.0.0-SNAPSHOT

Copyright © 2001-2013 JBoss by Red Hat. All Rights Reserved.