Fix logic for VPN badges and network menu order

There were a few bugs, and some confusing UI. I made the following changes:
* Moved the ShouldShowIconInTray() logic into NetworkMenuIcon.
* Removed the unused function GetVpnImage()
* Made VPN icon code similar to other network types
* Changed network display order to:
** Active network
** Connected networks (VPN, Ethernet, Cellular, Wimax, Wifi)
** Unconnected networks (same order)

BUG=137941

Review URL: https://chromiumcodereview.appspot.com/10824208

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@150607 0039d316-1c4b-4281-b951-d872f2087c98
4 files changed