com.sap.ui.commons.client
Class RoadMap

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.RoadMap

public class RoadMap
extends com.sap.ui.core.client.Control

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.ui.commons.RoadMap)

Constructor Summary

protected

RoadMap() constructs the class RoadMap hidden due to JavaScriptObject restriction

Method Summary

RoadMap	addStep(RoadMapStep step) Appends a step to the aggregation steps.
RoadMap	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.
RoadMap	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).
static RoadMap	create() creates a new instance of the class RoadMap
static RoadMap	create(String idOrConfig) creates a new instance of the class RoadMap
static RoadMap	create(String id, String config) creates a new instance of the class RoadMap
RoadMap	destroySteps() Destroys all the steps in the Steps-aggregation.
RoadMap	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.
RoadMap	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).
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.
RoadMap	insertStep(RoadMapStep step, int index) Inserts some step into the aggregation named steps.
boolean	isVisible() Getter for property visible Invisible Roadmap is not rendered
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<RoadMapStep>>	removeAllSteps() Removes all the items in the steps-aggregation.
com.sap.ui.core.client.js.JsArray<RoadMapStep>	removeStep(int index) Removes a step from the aggregation named steps.
RoadMap	setFirstVisibleStep(String value) Setter for property firstVisibleStep
RoadMap	setNumberOfVisibleSteps(int value) Setter for property numberOfVisibleSteps
RoadMap	setSelectedStep(String value) Setter for property selectedStep
RoadMap	setVisible(boolean value) Setter for property visible Default value is: true
RoadMap	setWidth(String value) Setter for property width Default value is: 100%

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

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

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

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RoadMap

protected RoadMap()

constructs the class RoadMap
hidden due to JavaScriptObject restriction

Method Detail

create

public static RoadMap create()

creates a new instance of the class RoadMap

create

public static RoadMap create(String idOrConfig)

creates a new instance of the class RoadMap

Parameters:

id - id of the RoadMap or configuration JSON string

create

public static RoadMap create(String id,
                             String config)

creates a new instance of the class RoadMap

Parameters:

id - id of the RoadMap

config - configuration JSON string

getNumberOfVisibleSteps

public final int getNumberOfVisibleSteps()

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

Returns:

the value of property numberOfVisibleSteps

setNumberOfVisibleSteps

public final RoadMap setNumberOfVisibleSteps(int value)

Setter for property numberOfVisibleSteps

Parameters:

value - int

Returns:

this to allow method chaining

getFirstVisibleStep

public final String getFirstVisibleStep()

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

Returns:

the value of property firstVisibleStep

setFirstVisibleStep

public final RoadMap setFirstVisibleStep(String value)

Setter for property firstVisibleStep

Parameters:

value - String

Returns:

this to allow method chaining

getSelectedStep

public final String getSelectedStep()

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

Returns:

the value of property selectedStep

setSelectedStep

public final RoadMap setSelectedStep(String value)

Setter for property selectedStep

Parameters:

value - String

Returns:

this to allow method chaining

getWidth

public final String getWidth()

Getter for property width Width of RoadMap

Returns:

the value of property width

setWidth

public final RoadMap setWidth(String value)

Setter for property width
Default value is: 100%

Parameters:

value - String

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Invisible Roadmap is not rendered

Returns:

the value of property visible

setVisible

public final RoadMap setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getSteps

public final 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 final RoadMap 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.

Returns:

this to allow method chaining

addStep

public final RoadMap addStep(RoadMapStep step)

Appends a step to the aggregation steps.

Parameters:

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

Returns:

this to allow method chaining

removeStep

public final com.sap.ui.core.client.js.JsArray<RoadMapStep> removeStep(int index)

Removes a step from the aggregation named steps.

Parameters:

index - int the position of the step to remove.

Returns:

reference to this instance

removeAllSteps

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

Removes all the items in the steps-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfStep

public final 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 final RoadMap destroySteps()

Destroys all the steps in the Steps-aggregation.

Returns:

this to allow method chaining

attachStepSelectedEvent

public final RoadMap 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

Returns:

this to allow method chaining

detachStepSelectedEvent

public final RoadMap 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

Returns:

this to allow method chaining

attachStepExpandedEvent

public final RoadMap 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

Returns:

this to allow method chaining

detachStepExpandedEvent

public final RoadMap 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

Returns:

this to allow method chaining