com.sap.ui.commons.client
Class RoadMapWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.RoadMapWidget

All Implemented Interfaces:

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.IsWidget

public class RoadMapWidget
extends com.sap.ui.core.client.ControlWidget

The class RoadMap is the GWT wrapper for the Phoenix control: sap.ui.commons.RoadMap.

The RoadMap control is used to display step by step workflows. This allows displaying small steps of a clearly defined work process.

• Properties
  • numberOfVisibleSteps : int
    Total number of steps to be displayed at once
  • firstVisibleStep : String
    The id of the first step to be display
  • selectedStep : String
    The id of the step which is selected
  • width : String
    Width of RoadMap
  • visible : boolean
    Invisible Roadmap is not rendered
• Aggregations
  • steps : com.sap.ui.commons.client.RoadMapStep
    Steps that are composing the RoadMap.
• Associations
• Events
  • stepSelected Event is fired when a given step is selected by user (when it was not selected before).
  • stepExpanded Event is fired when a given step is expanded or collapsed by user.

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: SAP AG)

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.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	RoadMapWidget() constructs the class RoadMapWidget
protected	RoadMapWidget(RoadMap control) constructs the class RoadMapWidget
	RoadMapWidget(String id) constructs the class RoadMapWidget

Method Summary

void	addStep(RoadMapStep step) Appends some step to the steps-aggregation.
void	attachStepExpandedEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when a given step is expanded or collapsed by user.
void	attachStepSelectedEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when a given step is selected by user (when it was not selected before).
void	destroySteps() Destroys all the steps in the Steps-aggregation.
void	detachStepExpandedEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when a given step is expanded or collapsed by user.
void	detachStepSelectedEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when a given step is selected by user (when it was not selected before).
RoadMap	getControl() returns the reference to the Phoenix Control
String	getFirstVisibleStep() Getter for property firstVisibleStep The id of the first step to be display
int	getNumberOfVisibleSteps() Getter for property numberOfVisibleSteps Total number of steps to be displayed at once
String	getSelectedStep() Getter for property selectedStep The id of the step which is selected
com.sap.ui.core.client.js.JsArray<RoadMapStep>	getSteps() Getter for aggregation steps Steps that are composing the RoadMap.
String	getWidth() Getter for property width Width of RoadMap
int	indexOfStep(RoadMapStep step) Checks for the provided com.sap.ui.commons.client.RoadMapStep in the steps-aggregation and returns its index if found or -1 otherwise.
void	insertStep(RoadMapStep step, int index) Inserts some step into the aggregation named steps.
boolean	isVisible() Getter for property visible Invisible Roadmap is not rendered
void	removeAllSteps() Removes all the items in the steps-aggregation.
void	removeStep(int index) Removes the step at position index in the steps-aggregation named.
void	setFirstVisibleStep(String value) Setter for property firstVisibleStep
void	setNumberOfVisibleSteps(int value) Setter for property numberOfVisibleSteps
void	setSelectedStep(String value) Setter for property selectedStep
void	setVisible(boolean value) Setter for property visible Default value is: true
void	setWidth(String value) Setter for property width Default value is: 100%

Methods inherited from class com.sap.ui.core.client.ControlWidget

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

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, onBrowserEvent, onDetach, onLoad, onUnload, 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, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

RoadMapWidget

public RoadMapWidget()

constructs the class RoadMapWidget

RoadMapWidget

public RoadMapWidget(String id)

constructs the class RoadMapWidget

Parameters:

id - id of the RoadMapWidget

RoadMapWidget

protected RoadMapWidget(RoadMap control)

constructs the class RoadMapWidget

Parameters:

control - reference to an existing RoadMap

Method Detail

getControl

public RoadMap getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

getNumberOfVisibleSteps

public int getNumberOfVisibleSteps()

Getter for property numberOfVisibleSteps Total number of steps to be displayed at once

Returns:

the value of property numberOfVisibleSteps

setNumberOfVisibleSteps

public void setNumberOfVisibleSteps(int value)

Setter for property numberOfVisibleSteps

Parameters:

value - int

getFirstVisibleStep

public String getFirstVisibleStep()

Getter for property firstVisibleStep The id of the first step to be display

Returns:

the value of property firstVisibleStep

setFirstVisibleStep

public void setFirstVisibleStep(String value)

Setter for property firstVisibleStep

Parameters:

value - String

getSelectedStep

public String getSelectedStep()

Getter for property selectedStep The id of the step which is selected

Returns:

the value of property selectedStep

setSelectedStep

public void setSelectedStep(String value)

Setter for property selectedStep

Parameters:

value - String

getWidth

public String getWidth()

Getter for property width Width of RoadMap

Returns:

the value of property width

setWidth

public void setWidth(String value)

Setter for property width
Default value is: 100%

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String

isVisible

public boolean isVisible()

Getter for property visible Invisible Roadmap is not rendered

Overrides:

isVisible in class com.google.gwt.user.client.ui.UIObject

Returns:

the value of property visible

setVisible

public void setVisible(boolean value)

Setter for property visible
Default value is: true

Overrides:

setVisible in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - boolean

getSteps

public com.sap.ui.core.client.js.JsArray<RoadMapStep> getSteps()

Getter for aggregation steps Steps that are composing the RoadMap.

Returns:

com.sap.ui.commons.client.RoadMapStep[]

insertStep

public void insertStep(RoadMapStep step,
                       int index)

Inserts some step into the aggregation named steps.

Parameters:

step - the step to insert

index - int the 0-based index the step should be inserted at.

addStep

public void addStep(RoadMapStep step)

Appends some step to the steps-aggregation.

Parameters:

step - com.sap.ui.commons.client.RoadMapStep the step to add

removeStep

public void removeStep(int index)

Removes the step at position index in the steps-aggregation named.

Parameters:

index - int the position of the step to remove.

removeAllSteps

public void removeAllSteps()

Removes all the items in the steps-aggregation.

indexOfStep

public int indexOfStep(RoadMapStep step)

Checks for the provided com.sap.ui.commons.client.RoadMapStep in the steps-aggregation and returns its index if found or -1 otherwise.

Parameters:

step - the step whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroySteps

public void destroySteps()

Destroys all the steps in the Steps-aggregation.

attachStepSelectedEvent

public void attachStepSelectedEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Event is fired when a given step is selected by user (when it was not selected before).

Event Parameters:

{sap.ui.core/string} stepId Id of the selected step.

Parameters:

listener - reference to the EventListener

detachStepSelectedEvent

public void detachStepSelectedEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Event is fired when a given step is selected by user (when it was not selected before).

Parameters:

listener - reference to the EventListener

attachStepExpandedEvent

public void attachStepExpandedEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Event is fired when a given step is expanded or collapsed by user.

Event Parameters:

{sap.ui.core/string} stepId Id of the exapanded/collapsed step.

Parameters:

listener - reference to the EventListener

detachStepExpandedEvent

public void detachStepExpandedEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Event is fired when a given step is expanded or collapsed by user.

Parameters:

listener - reference to the EventListener